Changeset 51385

Timestamp:

07/09/2021 12:59:15 AM (5 years ago)

Author:

desrosj

Message:

REST API: Ensure a sidebar's widgets property is a list.

When a widget is removed from a sidebar, if it was removed from the middle of the list, the widgets property would become an object with numeric keys.

The sidebars controller now forces the widgets property to be a list.

Props walbo, timothyblynjacobs.
Merges [51377] to the 5.8 branch.
Fixes #53612.

Location:

branches/5.8

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-sidebars-controller.php (modified) (3 diffs)

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

@@ -305 +305 @@
                         );
 
-                        $sidebar['widgets'] = $widgets;
+                        $sidebar['widgets'] = array_values( $widgets );
                 }
 

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

@@ -76 +76 @@
 
         private function setup_widget( $option_name, $number, $settings ) {
-                update_option(
+                $this->setup_widgets(
                         $option_name,
                         array(
@@ -82 +82 @@
                         )
                 );
+        }
+
+        private function setup_widgets( $option_name, $settings ) {
+                update_option( $option_name, $settings );
         }
 
@@ -492 +496 @@
 
         /**
+         * @ticket 53612
+         */
+        public function test_batch_remove_widgets_from_existing_sidebar() {
+                wp_widgets_init();
+
+                $this->setup_widgets(
+                        'widget_text',
+                        array(
+                                2 => array( 'text' => 'Text widget' ),
+                                3 => array( 'text' => 'Text widget' ),
+                                4 => array( 'text' => 'Text widget' ),
+                                5 => array( 'text' => 'Text widget' ),
+                                6 => array( 'text' => 'Text widget' ),
+                        )
+                );
+
+                $this->setup_sidebar(
+                        'sidebar-1',
+                        array(
+                                'name' => 'Test sidebar',
+                        ),
+                        array( 'text-2', 'text-3', 'text-4', 'text-5', 'text-6' )
+                );
+
+                $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',
+                                        ),
+                                ),
+                        )
+                );
+                rest_get_server()->dispatch( $request );
+
+                $this->assertSame(
+                        array( 'text-4', 'text-5', 'text-6' ),
+                        rest_do_request( '/wp/v2/sidebars/sidebar-1' )->get_data()['widgets']
+                );
+        }
+
+        /**
          * @ticket 41683
          */