Changeset 55200 for trunk/src/wp-includes/theme.php

Timestamp:

02/03/2023 12:13:52 AM (2 years 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.

File:

• trunk/src/wp-includes/theme.php (modified) (2 diffs)

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 );
     }