Changeset 51290

Timestamp:

06/30/2021 06:45:14 PM (3 years ago)

Author:

desrosj

Message:

REST API: Allow multiple widgets to be deleted in a single batch request.

This resets the WP_Widget::$updated flag when deleting a widget, to avoid blocking all future updates in a request.

Props noisysocks, andraganescu.
Merges [51277] to the 5.8 branch.
Fixes #53557.

Location:

branches/5.8

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php (modified) (4 diffs)
• tests/phpunit/tests/rest-api/rest-widgets-controller.php (modified) (2 diffs)

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

@@ -290 +290 @@
      * @since 5.8.0
      *
-     * @global array $wp_registered_widget_updates The registered widget update functions.
+     * @global array             $wp_registered_widget_updates The registered widget update functions.
+     * @global WP_Widget_Factory $wp_widget_factory
      *
      * @param WP_REST_Request $request Full details about the request.
@@ -296 +297 @@
      */
     public function delete_item( $request ) {
-        global $wp_registered_widget_updates;
+        global $wp_registered_widget_updates, $wp_widget_factory;
 
         retrieve_widgets();
@@ -344 +345 @@
             $_POST    = $original_post;
             $_REQUEST = $original_request;
+
+            $widget_object = $wp_widget_factory->get_widget_object( $id_base );
+
+            if ( $widget_object ) {
+                /*
+                 * WP_Widget sets `updated = true` after an update to prevent more than one widget
+                 * from being saved per request. This isn't what we want in the REST API, though,
+                 * as we support batch requests.
+                 */
+                $widget_object->updated = false;
+            }
 
             wp_assign_widget_to_sidebar( $widget_id, '' );
@@ -521 +533 @@
             $widget_object->_register_one( $number );
 
-            // WP_Widget sets updated = true after an update to prevent more
-            // than one widget from being saved per request. This isn't what we
-            // want in the REST API, though, as we support batch requests.
+            /*
+             * WP_Widget sets `updated = true` after an update to prevent more than one widget
+             * from being saved per request. This isn't what we want in the REST API, though,
+             * as we support batch requests.
+             */
             $widget_object->updated = false;
         }

branches/5.8/tests/phpunit/tests/rest-api/rest-widgets-controller.php

@@ -166 +166 @@
 
     private function setup_widget( $id_base, $number, $settings ) {
+        $this->setup_widgets( $id_base, array( $number => $settings ) );
+    }
+
+    private function setup_widgets( $id_base, $settings ) {
         global $wp_widget_factory;
 
         $option_name = "widget_$id_base";
-        update_option(
-            $option_name,
-            array(
-                $number => $settings,
-            )
-        );
+        update_option( $option_name, $settings );
 
         $widget_object = $wp_widget_factory->get_widget_object( $id_base );
-        $widget_object->_set( $number );
-        $widget_object->_register_one( $number );
+        foreach ( array_keys( $settings ) as $number ) {
+            $widget_object->_set( $number );
+            $widget_object->_register_one( $number );
+        }
     }
 
@@ -1380 +1381 @@
 
     /**
+     * @ticket 53557
+     */
+    public function test_delete_item_multiple() {
+        $this->setup_widgets(
+            'text',
+            array(
+                2 => array( 'text' => 'Text widget' ),
+                3 => array( 'text' => 'Text widget' ),
+                4 => array( 'text' => 'Text widget' ),
+            )
+        );
+        $this->setup_sidebar(
+            'sidebar-1',
+            array(
+                'name' => 'Test sidebar',
+            ),
+            array( 'text-2', 'text-3', 'text-4' )
+        );
+
+        $request = new WP_REST_Request( 'POST', '/batch/v1' );
+        $request->set_body_params(
+            array(
+                'requests' => array(
+                    array(
+                        'method' => 'DELETE',
+                        'path'   => '/wp/v2/widgets/text-2?force=1',
+                    ),
+                    array(
+                        'method' => 'DELETE',
+                        'path'   => '/wp/v2/widgets/text-3?force=1',
+                    ),
+                    array(
+                        'method' => 'DELETE',
+                        'path'   => '/wp/v2/widgets/text-4?force=1',
+                    ),
+                ),
+            )
+        );
+        $response = rest_do_request( $request );
+
+        $this->assertSame(
+            array(
+                'sidebar-1' => array(),
+            ),
+            wp_get_sidebars_widgets()
+        );
+        $this->assertSame(
+            array(
+                '_multiwidget' => 1,
+            ),
+            get_option( 'widget_text' )
+        );
+    }
+
+    /**
      * The test_prepare_item() method does not exist for sidebar.
      */