Changeset 51068

Timestamp:

06/04/2021 12:44:41 AM (5 years ago)

Author:

noisysocks

Message:

REST API: Delete fresh_site option when updating widgets via REST API

Adds new hooks (rest_save_sidebar, rest_delete_widget, rest_after_save_widget)
to the widgets REST API and uses them to delete the fresh_site option when
updating widgets via the REST API. This ensures that starter content isn't
loaded in the Customizer after a user makes changes.

Fixes #53317.
Props kevin940726, garrett-eclipse, andraganescu, hellofromtonya.

Location:

trunk/src/wp-includes

Files:

• default-filters.php (modified) (1 diff)
• rest-api/endpoints/class-wp-rest-sidebars-controller.php (modified) (1 diff)
• rest-api/endpoints/class-wp-rest-widgets-controller.php (modified) (7 diffs)

trunk/src/wp-includes/default-filters.php

@@ -247 +247 @@
 
 // Mark site as no longer fresh.
-foreach ( array( 'publish_post', 'publish_page', 'wp_ajax_save-widget', 'wp_ajax_widgets-order', 'customize_save_after' ) as $action ) {
+foreach (
+        array(
+                'publish_post',
+                'publish_page',
+                'wp_ajax_save-widget',
+                'wp_ajax_widgets-order',
+                'customize_save_after',
+                'rest_after_save_widget',
+                'rest_delete_widget',
+                'rest_save_sidebar',
+        ) as $action
+) {
         add_action( $action, '_delete_option_fresh_site', 0 );
 }

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php

@@ -210 +210 @@
                 $sidebar = $this->get_sidebar( $request['id'] );
 
+                /**
+                 * Fires after a sidebar is updated via the REST API.
+                 *
+                 * @since 5.8.0
+                 * @param array           $sidebar  The updated sidebar.
+                 * @param WP_REST_Request $request  Request object.
+                 */
+                do_action( 'rest_save_sidebar', $sidebar, $request );
+
                 return $this->prepare_item_for_response( $sidebar, $request );
         }

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

@@ -187 +187 @@
                 $sidebar_id = $request['sidebar'];
 
-                $widget_id = $this->save_widget( $request );
+                $widget_id = $this->save_widget( $request, $sidebar_id );
 
                 if ( is_wp_error( $widget_id ) ) {
@@ -249 +249 @@
                         $request->has_param( 'form_data' )
                 ) {
-                        $maybe_error = $this->save_widget( $request );
+                        $maybe_error = $this->save_widget( $request, $sidebar_id );
                         if ( is_wp_error( $maybe_error ) ) {
                                 return $maybe_error;
@@ -356 +356 @@
                         );
                 }
+
+                /**
+                 * Fires after a widget is deleted via the REST API.
+                 *
+                 * @since 5.8.0
+                 * @param string           $widget_id  ID of the widget marked for deletion.
+                 * @param string           $sidebar_id ID of the sidebar the widget was deleted from.
+                 * @param WP_REST_Response $response   The response data.
+                 * @param WP_REST_Request  $request    The request sent to the API.
+                 */
+                do_action( 'rest_delete_widget', $widget_id, $sidebar_id, $response, $request );
 
                 return $response;
@@ -386 +397 @@
          * @since 5.8.0
          *
-         * @param WP_REST_Request $request Full details about the request.
+         * @param WP_REST_Request $request    Full details about the request.
+         * @param string          $sidebar_id ID of the sidebar the widget belongs to.
          *
          * @return string|WP_Error The saved widget ID.
          */
-        protected function save_widget( $request ) {
+        protected function save_widget( $request, $sidebar_id ) {
                 global $wp_widget_factory, $wp_registered_widget_updates;
 
@@ -402 +414 @@
                         $number        = isset( $parsed_id['number'] ) ? $parsed_id['number'] : null;
                         $widget_object = $wp_widget_factory->get_widget_object( $id_base );
+                        $creating      = false;
                 } elseif ( $request['id_base'] ) {
                         // Saving a new widget.
@@ -408 +421 @@
                         $number        = $widget_object ? next_widget_id_number( $id_base ) : null;
                         $id            = $widget_object ? $id_base . '-' . $number : $id_base;
+                        $creating      = true;
                 } else {
                         return new WP_Error(
@@ -503 +517 @@
                 }
 
+                /**
+                 * Fires after a widget is created or updated via the REST API.
+                 *
+                 * @since 5.8.0
+                 * @param string          $id         ID of the widget being saved.
+                 * @param string          $sidebar_id ID of the sidebar containing the widget being saved.
+                 * @param WP_REST_Request $request    Request object.
+                 * @param bool            $creating   True when creating a widget, false when updating.
+                 */
+                do_action( 'rest_after_save_widget', $id, $sidebar_id, $request, $creating );
+
                 return $id;
         }