Changeset 55200

Timestamp:

02/03/2023 12:13:52 AM (23 months ago)

Author:

hellofromTonya

Message:

Widgets: Preserve classic sidebars when switching to a block theme.

When switching to a block theme, classic sidebars were orphaned and their widgets remapping to the 'wp_inactive_widgets' sidebar . This changeset preserves the sidebars and their widgets, providing a migration path to a block theme without losing the widgets.

Classic sidebars are now:

• Stored in a new theme mod called 'wp_classic_sidebars';
• Restored to the $wp_registered_sidebars global variable when the 'widgets_init' action fires (via a new internal function called _wp_block_theme_register_classic_sidebars());
• And marked as 'inactive' when interacting with sidebars REST API endpoint.

References:

• ​Gutenberg PR 45509 which adds an option for importing widgets from sidebars into template parts.

Follow-up to [50995], [6334].

Props mamaduka, audrasjb, hellofromTonya, ironprogrammer, jameskoster, joen, matveb, mukesh27, noisysocks, poena, youknowriad.
Fixes #57531.

Location:

trunk

Files:

• src/wp-includes/default-filters.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php (modified) (1 diff)
• src/wp-includes/theme.php (modified) (2 diffs)
• src/wp-includes/widgets.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-sidebars-controller.php (modified) (1 diff)
• tests/phpunit/tests/widgets/wpBlockThemeRegisterClassicSidebar.php (added)

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

@@ -627 +627 @@
 add_action( 'init', 'wp_widgets_init', 1 );
 add_action( 'change_locale', array( 'WP_Widget_Media', 'reset_default_labels' ) );
+add_action( 'widgets_init', '_wp_block_theme_register_classic_sidebars', 1 );
 
 // Admin Bar.

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

@@ -340 +340 @@
         }
 
+        if ( wp_is_block_theme() ) {
+            $sidebar['status'] = 'inactive';
+        }
+
         $fields = $this->get_fields_for_response( $request );
         if ( rest_is_field_included( 'widgets', $fields ) ) {

trunk/src/wp-includes/theme.php

@@ -734 +734 @@
  * @global WP_Customize_Manager $wp_customize
  * @global array                $sidebars_widgets
+ * @global array                $wp_registered_sidebars
  *
  * @param string $stylesheet Stylesheet name.
  */
 function switch_theme( $stylesheet ) {
-    global $wp_theme_directories, $wp_customize, $sidebars_widgets;
+    global $wp_theme_directories, $wp_customize, $sidebars_widgets, $wp_registered_sidebars;
 
     $requirements = validate_theme_requirements( $stylesheet );
@@ -813 +814 @@
             remove_theme_mod( 'sidebars_widgets' );
         }
+    }
+
+    // Stores classic sidebars for later use by block themes.
+    if ( $new_theme->is_block_theme() ) {
+        set_theme_mod( 'wp_classic_sidebars', $wp_registered_sidebars );
     }
 

trunk/src/wp-includes/widgets.php

@@ -2106 +2106 @@
     }
 }
+
+/**
+ * Registers the previous theme's sidebars for the block themes.
+ *
+ * @since 6.2.0
+ * @access private
+ *
+ * @global array $wp_registered_sidebars Registered sidebars.
+ */
+function _wp_block_theme_register_classic_sidebars() {
+    global $wp_registered_sidebars;
+
+    if ( ! wp_is_block_theme() ) {
+        return;
+    }
+
+    $classic_sidebars = get_theme_mod( 'wp_classic_sidebars' );
+    if ( empty( $classic_sidebars ) ) {
+        return;
+    }
+
+    // Don't use `register_sidebar` since it will enable the `widgets` support for a theme.
+    foreach ( $classic_sidebars as $sidebar ) {
+        $wp_registered_sidebars[ $sidebar['id'] ] = $sidebar;
+    }
+}

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

@@ -862 +862 @@
 
     /**
+     * @ticket 57531
+     * @covers WP_Test_REST_Sidebars_Controller::prepare_item_for_response
+     */
+    public function test_prepare_item_for_response_to_set_inactive_on_theme_switch() {
+        $request = new WP_REST_Request( 'GET', '/wp/v2/sidebars/sidebar-1' );
+
+        // Set up the test.
+        wp_widgets_init();
+        $this->setup_widget(
+            'widget_rss',
+            1,
+            array(
+                'title' => 'RSS test',
+            )
+        );
+        $this->setup_widget(
+            'widget_text',
+            1,
+            array(
+                'text' => 'Custom text test',
+            )
+        );
+        $this->setup_sidebar(
+            'sidebar-1',
+            array(
+                'name' => 'Sidebar 1',
+            ),
+            array( 'text-1', 'rss-1' )
+        );
+
+        // Validate the state before a theme switch.
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+        $data     = $this->remove_links( $data );
+
+        $this->assertSame( 'active', $data['status'] );
+        $this->assertFalse(
+            get_theme_mod( 'wp_classic_sidebars' ),
+            'wp_classic_sidebars theme mod should not exist before switching to block theme'
+        );
+
+        switch_theme( 'block-theme' );
+        wp_widgets_init();
+
+        // Validate the state after a theme switch.
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+        $data     = $this->remove_links( $data );
+
+        $this->assertSame(
+            'inactive',
+            $data['status'],
+            'Sidebar status should have changed to inactive'
+        );
+        $this->assertSame(
+            array( 'text-1', 'rss-1' ),
+            $data['widgets'],
+            'The text and rss widgets should still in sidebar-1'
+        );
+        $this->assertArrayHasKey(
+            'sidebar-1',
+            get_theme_mod( 'wp_classic_sidebars' ),
+            'sidebar-1 should be in "wp_classic_sidebars" theme mod'
+        );
+    }
+
+    /**
      * @ticket 41683
      */