Changeset 55200 for trunk/src/wp-includes/widgets.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/widgets.php (modified) (1 diff)

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