Changeset 51235

Timestamp:

06/25/2021 01:17:20 PM (3 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Retrieve latest widgets before loading sidebars.

This fixes issues where sidebars would be unexpectedly missing from the new widgets screen. Running retrieve_widgets syncs sidebars that were registered after the last theme switch.

Props walbo, hellofromTonya, noisysocks.
Fixes #53489.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-sidebars-controller.php (modified) (9 diffs)
• tests/phpunit/tests/rest-api/rest-widget-types-controller.php (modified) (1 diff)

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

@@ -99 +99 @@
      */
     public function get_items( $request ) {
+        retrieve_widgets();
+
         $data = array();
-        foreach ( (array) wp_get_sidebars_widgets() as $id => $widgets ) {
+        foreach ( wp_get_sidebars_widgets() as $id => $widgets ) {
             $sidebar = $this->get_sidebar( $id );
 
@@ -136 +138 @@
      */
     public function get_item( $request ) {
+        retrieve_widgets();
+
         $sidebar = $this->get_sidebar( $request['id'] );
 

trunk/tests/phpunit/tests/rest-api/rest-sidebars-controller.php

@@ -9 +9 @@
 
 /**
- * Tests for REST API for Menus.
+ * Tests for REST API for Widgets.
  *
  * @see WP_Test_REST_Controller_Testcase
  * @group restapi
+ * @group widgets
  * @covers WP_REST_Sidebars_Controller
  */
@@ -60 +61 @@
         $_wp_sidebars_widgets   = array();
         update_option( 'sidebars_widgets', array() );
+    }
+
+    function clean_up_global_scope() {
+        global $wp_widget_factory, $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates;
+
+        $wp_registered_sidebars        = array();
+        $wp_registered_widgets         = array();
+        $wp_registered_widget_controls = array();
+        $wp_registered_widget_updates  = array();
+        $wp_widget_factory->widgets    = array();
+
+        parent::clean_up_global_scope();
     }
 
@@ -129 +142 @@
      */
     public function test_get_items() {
+        wp_widgets_init();
+
         $request  = new WP_REST_Request( 'GET', '/wp/v2/sidebars' );
         $response = rest_get_server()->dispatch( $request );
@@ -194 +209 @@
      */
     public function test_get_items_active_sidebar_with_widgets() {
+        wp_widgets_init();
+
         $this->setup_widget(
             'widget_rss',
@@ -243 +260 @@
 
     /**
+     * @ticket 53489
+     */
+    public function test_get_items_when_registering_new_sidebars() {
+        register_sidebar(
+            array(
+                'name'          => 'New Sidebar',
+                'id'            => 'new-sidebar',
+                'before_widget' => '',
+                'after_widget'  => '',
+                'before_title'  => '',
+                'after_title'   => '',
+            )
+        );
+
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/sidebars' );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+        $data     = $this->remove_links( $data );
+        $this->assertSame(
+            array(
+                array(
+                    'id'            => 'wp_inactive_widgets',
+                    'name'          => 'Inactive widgets',
+                    'description'   => '',
+                    'class'         => '',
+                    'before_widget' => '',
+                    'after_widget'  => '',
+                    'before_title'  => '',
+                    'after_title'   => '',
+                    'status'        => 'inactive',
+                    'widgets'       => array(),
+                ),
+                array(
+                    'id'            => 'new-sidebar',
+                    'name'          => 'New Sidebar',
+                    'description'   => '',
+                    'class'         => '',
+                    'before_widget' => '',
+                    'after_widget'  => '',
+                    'before_title'  => '',
+                    'after_title'   => '',
+                    'status'        => 'active',
+                    'widgets'       => array(),
+                ),
+            ),
+            $data
+        );
+    }
+
+    /**
      * @ticket 41683
      */
@@ -318 +385 @@
      */
     public function test_update_item() {
+        wp_widgets_init();
+
         $this->setup_widget(
             'widget_rss',
@@ -383 +452 @@
      */
     public function test_update_item_removes_widget_from_existing_sidebar() {
+        wp_widgets_init();
+
         $this->setup_widget(
             'widget_text',
@@ -424 +495 @@
      */
     public function test_update_item_moves_omitted_widget_to_inactive_sidebar() {
+        wp_widgets_init();
+
         $this->setup_widget(
             'widget_text',
@@ -466 +539 @@
      */
     public function test_get_items_inactive_widgets() {
+        wp_widgets_init();
+
         $this->setup_widget(
             'widget_rss',

trunk/tests/phpunit/tests/rest-api/rest-widget-types-controller.php

@@ -113 +113 @@
      */
     public function test_get_items() {
+        wp_widgets_init();
         wp_set_current_user( self::$admin_id );
         $request  = new WP_REST_Request( 'GET', '/wp/v2/widget-types' );