-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f638d64
commit a974bba
Showing
21 changed files
with
986 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,186 @@ | ||
| <?php | ||
| /** | ||
| * Start: Include for phase 2 | ||
| * Widget Updater REST API: WP_REST_Widget_Updater_Controller class | ||
| * | ||
| * @package gutenberg | ||
| * @since 5.2.0 | ||
| */ | ||
|
|
||
| /** | ||
| * Controller which provides REST endpoint for updating a widget. | ||
| * | ||
| * @since 5.2.0 | ||
| * | ||
| * @see WP_REST_Controller | ||
| */ | ||
| class WP_REST_Widget_Updater_Controller extends WP_REST_Controller { | ||
|
|
||
| /** | ||
| * Constructs the controller. | ||
| * | ||
| * @access public | ||
| */ | ||
| public function __construct() { | ||
| $this->namespace = 'wp/v2'; | ||
| $this->rest_base = 'widgets'; | ||
| } | ||
|
|
||
| /** | ||
| * Registers the necessary REST API route. | ||
| * | ||
| * @access public | ||
| */ | ||
| public function register_routes() { | ||
| register_rest_route( | ||
| $this->namespace, | ||
| // Regex representing a PHP class extracted from http://php.net/manual/en/language.oop5.basic.php. | ||
| '/' . $this->rest_base . '/(?P<identifier>[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)/', | ||
| array( | ||
| 'args' => array( | ||
| 'identifier' => array( | ||
| 'description' => __( 'Class name of the widget.', 'gutenberg' ), | ||
| 'type' => 'string', | ||
| ), | ||
| ), | ||
| array( | ||
| 'methods' => WP_REST_Server::EDITABLE, | ||
| 'permission_callback' => array( $this, 'compute_new_widget_permissions_check' ), | ||
| 'callback' => array( $this, 'compute_new_widget' ), | ||
| ), | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Checks if the user has permissions to make the request. | ||
| * | ||
| * @since 5.2.0 | ||
| * @access public | ||
| * | ||
| * @return true|WP_Error True if the request has read access, WP_Error object otherwise. | ||
| */ | ||
| public function compute_new_widget_permissions_check() { | ||
| // Verify if the current user has edit_theme_options capability. | ||
| // This capability is required to access the widgets screen. | ||
| if ( ! current_user_can( 'edit_theme_options' ) ) { | ||
| return new WP_Error( | ||
| 'widgets_cannot_access', | ||
| __( 'Sorry, you are not allowed to access widgets on this site.', 'gutenberg' ), | ||
| array( | ||
| 'status' => rest_authorization_required_code(), | ||
| ) | ||
| ); | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the new widget instance and the form that represents it. | ||
| * | ||
| * @since 5.2.0 | ||
| * @access public | ||
| * | ||
| * @param WP_REST_Request $request Full details about the request. | ||
| * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. | ||
| */ | ||
| public function compute_new_widget( $request ) { | ||
| $url_params = $request->get_url_params(); | ||
|
|
||
| $widget = $request->get_param( 'identifier' ); | ||
|
|
||
| global $wp_widget_factory; | ||
|
|
||
| if ( | ||
| null === $widget || | ||
| ! isset( $wp_widget_factory->widgets[ $widget ] ) || | ||
| ! ( $wp_widget_factory->widgets[ $widget ] instanceof WP_Widget ) | ||
| ) { | ||
| return new WP_Error( | ||
| 'widget_invalid', | ||
| __( 'Invalid widget.', 'gutenberg' ), | ||
| array( | ||
| 'status' => 404, | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| $widget_obj = $wp_widget_factory->widgets[ $widget ]; | ||
|
|
||
| $instance = $request->get_param( 'instance' ); | ||
| if ( null === $instance ) { | ||
| $instance = array(); | ||
| } | ||
| $id_to_use = $request->get_param( 'id_to_use' ); | ||
| if ( null === $id_to_use ) { | ||
| $id_to_use = -1; | ||
| } | ||
|
|
||
| $widget_obj->_set( $id_to_use ); | ||
| ob_start(); | ||
|
|
||
| $instance_changes = $request->get_param( 'instance_changes' ); | ||
| if ( null !== $instance_changes ) { | ||
| $old_instance = $instance; | ||
| $instance = $widget_obj->update( $instance_changes, $old_instance ); | ||
| /** | ||
| * Filters a widget's settings before saving. | ||
| * | ||
| * Returning false will effectively short-circuit the widget's ability | ||
| * to update settings. The old setting will be returned. | ||
| * | ||
| * @since 5.2.0 | ||
| * | ||
| * @param array $instance The current widget instance's settings. | ||
| * @param array $instance_changes Array of new widget settings. | ||
| * @param array $old_instance Array of old widget settings. | ||
| * @param WP_Widget $widget_ob The widget instance. | ||
| */ | ||
| $instance = apply_filters( 'widget_update_callback', $instance, $instance_changes, $old_instance, $widget_obj ); | ||
| if ( false === $instance ) { | ||
| $instance = $old_instance; | ||
| } | ||
| } | ||
|
|
||
| $instance = apply_filters( 'widget_form_callback', $instance, $widget_obj ); | ||
|
|
||
| $return = null; | ||
| if ( false !== $instance ) { | ||
| $return = $widget_obj->form( $instance ); | ||
|
|
||
| /** | ||
| * Fires at the end of the widget control form. | ||
| * | ||
| * Use this hook to add extra fields to the widget form. The hook | ||
| * is only fired if the value passed to the 'widget_form_callback' | ||
| * hook is not false. | ||
| * | ||
| * Note: If the widget has no form, the text echoed from the default | ||
| * form method can be hidden using CSS. | ||
| * | ||
| * @since 5.2.0 | ||
| * | ||
| * @param WP_Widget $widget_obj The widget instance (passed by reference). | ||
| * @param null $return Return null if new fields are added. | ||
| * @param array $instance An array of the widget's settings. | ||
| */ | ||
| do_action_ref_array( 'in_widget_form', array( &$widget_obj, &$return, $instance ) ); | ||
| } | ||
|
|
||
| $id_base = $widget_obj->id_base; | ||
| $id = $widget_obj->id; | ||
| $form = ob_get_clean(); | ||
|
|
||
| return rest_ensure_response( | ||
| array( | ||
| 'instance' => $instance, | ||
| 'form' => $form, | ||
| 'id_base' => $id_base, | ||
| 'id' => $id, | ||
| ) | ||
| ); | ||
| } | ||
| } | ||
| /** | ||
| * End: Include for phase 2 | ||
| */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.