<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[55200] trunk: Widgets: Preserve classic sidebars when switching to a block theme.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/55200">55200</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/55200","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-02-03 00:13:52 +0000 (Fri, 03 Feb 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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:
* [https://github.com/WordPress/gutenberg/pull/45509 Gutenberg PR 45509] which adds an option for importing widgets from sidebars into template parts.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/50995">[50995]</a>, <a href="https://core.trac.wordpress.org/changeset/6334">[6334]</a>.
Props mamaduka, audrasjb, hellofromTonya, ironprogrammer, jameskoster, joen, matveb, mukesh27, noisysocks, poena, youknowriad.
Fixes <a href="https://core.trac.wordpress.org/ticket/57531">#57531</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesdefaultfiltersphp">trunk/src/wp-includes/default-filters.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestsidebarscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php</a></li>
<li><a href="#trunksrcwpincludesthemephp">trunk/src/wp-includes/theme.php</a></li>
<li><a href="#trunksrcwpincludeswidgetsphp">trunk/src/wp-includes/widgets.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestsidebarscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-sidebars-controller.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestswidgetswpBlockThemeRegisterClassicSidebarphp">trunk/tests/phpunit/tests/widgets/wpBlockThemeRegisterClassicSidebar.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesdefaultfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/default-filters.php 2023-02-02 23:38:49 UTC (rev 55199)
+++ trunk/src/wp-includes/default-filters.php 2023-02-03 00:13:52 UTC (rev 55200)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -626,6 +626,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'after_setup_theme', 'wp_setup_widgets_block_editor', 1 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'init', 'wp_widgets_init', 1 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'change_locale', array( 'WP_Widget_Media', 'reset_default_labels' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_action( 'widgets_init', '_wp_block_theme_register_classic_sidebars', 1 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Admin Bar.
</span><span class="cx" style="display: block; padding: 0 10px"> // Don't remove. Wrong way to disable.
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestsidebarscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php 2023-02-02 23:38:49 UTC (rev 55199)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php 2023-02-03 00:13:52 UTC (rev 55200)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -339,6 +339,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebar['class'] = '';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( wp_is_block_theme() ) {
+ $sidebar['status'] = 'inactive';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $fields = $this->get_fields_for_response( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( rest_is_field_included( 'widgets', $fields ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebars = wp_get_sidebars_widgets();
</span></span></pre></div>
<a id="trunksrcwpincludesthemephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/theme.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/theme.php 2023-02-02 23:38:49 UTC (rev 55199)
+++ trunk/src/wp-includes/theme.php 2023-02-03 00:13:52 UTC (rev 55200)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -733,11 +733,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_theme_directories
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Customize_Manager $wp_customize
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $sidebars_widgets
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_registered_sidebars
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $stylesheet Stylesheet name.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function switch_theme( $stylesheet ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $wp_theme_directories, $wp_customize, $sidebars_widgets;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $wp_theme_directories, $wp_customize, $sidebars_widgets, $wp_registered_sidebars;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $requirements = validate_theme_requirements( $stylesheet );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $requirements ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -814,6 +815,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Stores classic sidebars for later use by block themes.
+ if ( $new_theme->is_block_theme() ) {
+ set_theme_mod( 'wp_classic_sidebars', $wp_registered_sidebars );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> update_option( 'theme_switched', $old_theme->get_stylesheet() );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunksrcwpincludeswidgetsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/widgets.php 2023-02-02 23:38:49 UTC (rev 55199)
+++ trunk/src/wp-includes/widgets.php 2023-02-03 00:13:52 UTC (rev 55200)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2105,3 +2105,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * 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;
+ }
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestsrestapirestsidebarscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-sidebars-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-sidebars-controller.php 2023-02-02 23:38:49 UTC (rev 55199)
+++ trunk/tests/phpunit/tests/rest-api/rest-sidebars-controller.php 2023-02-03 00:13:52 UTC (rev 55200)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -861,6 +861,73 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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'
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 41683
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_update_item_no_permission() {
</span></span></pre></div>
<a id="trunktestsphpunittestswidgetswpBlockThemeRegisterClassicSidebarphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/widgets/wpBlockThemeRegisterClassicSidebar.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/widgets/wpBlockThemeRegisterClassicSidebar.php (rev 0)
+++ trunk/tests/phpunit/tests/widgets/wpBlockThemeRegisterClassicSidebar.php 2023-02-03 00:13:52 UTC (rev 55200)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,89 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Tests for _wp_block_theme_register_classic_sidebars().
+ *
+ * @group widgets
+ * @covers ::_wp_block_theme_register_classic_sidebars
+ */
+class Tests_Widgets_WpBlockThemeRegisterClassicSidebars extends WP_UnitTestCase {
+ /**
+ * Original global $wp_registered_sidebars.
+ *
+ * @var array
+ */
+ private static $wp_registered_sidebars;
+
+ public static function set_up_before_class() {
+ global $wp_registered_sidebars;
+ parent::set_up_before_class();
+
+ // Store the original global before running tests.
+ static::$wp_registered_sidebars = $wp_registered_sidebars;
+ }
+
+ public function tear_down() {
+ // Restore the global after each test.
+ global $wp_registered_sidebars;
+ $wp_registered_sidebars = static::$wp_registered_sidebars;
+
+ parent::tear_down();
+ }
+
+ public function test_a_sidebar_should_be_registered() {
+ global $wp_registered_sidebars;
+
+ $sidebar_id = array_key_first( $wp_registered_sidebars );
+ $this->assertNotEmpty( $sidebar_id );
+ }
+
+ /**
+ * @ticket 57531
+ */
+ public function test_should_reregister_previous_theme_sidebar() {
+ global $wp_registered_sidebars;
+
+ $sidebar_id = array_key_first( $wp_registered_sidebars );
+
+ switch_theme( 'block-theme' );
+ unregister_sidebar( $sidebar_id );
+
+ // Test before.
+ $this->assertArrayNotHasKey(
+ $sidebar_id,
+ $wp_registered_sidebars,
+ 'Sidebar should not be in registered sidebars after unregister'
+ );
+
+ _wp_block_theme_register_classic_sidebars();
+
+ // Test after.
+ $this->assertArrayHasKey(
+ $sidebar_id,
+ $wp_registered_sidebars,
+ 'Sidebar should be in registered sidebars after invoking _wp_block_theme_register_classic_sidebars()'
+ );
+ }
+
+ /**
+ * @ticket 57531
+ */
+ public function test_should_bail_out_when_theme_mod_is_empty() {
+ global $wp_registered_sidebars;
+
+ // Test state before invoking.
+ $this->assertFalse(
+ get_theme_mod( 'wp_classic_sidebars' ),
+ 'Theme mod should not be set before invoking _wp_block_theme_register_classic_sidebars()'
+ );
+
+ $before = $wp_registered_sidebars;
+ _wp_block_theme_register_classic_sidebars();
+
+ // Test state after invoking.
+ $this->assertSameSetsWithIndex(
+ $before,
+ $wp_registered_sidebars,
+ 'No change should happen after invoking _wp_block_theme_register_classic_sidebars()'
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/widgets/wpBlockThemeRegisterClassicSidebar.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>