<!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>[51705] trunk: Widgets: Rename and soft deprecate `retrieve_widgets()`.</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/51705">51705</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/51705","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>2021-08-31 19:57:20 +0000 (Tue, 31 Aug 2021)</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: Rename and soft deprecate `retrieve_widgets()`.
The original name `retrieve_widgets()` was unclear as it suggested it was a getter, i.e. getting the widgets. This function does more than get: finds orphaned widgets, assigns them to the inactive sidebar, and updates the database.
The new name is `sync_registered_widgets()` which better represents what happens when this function is invoked.
The original `retrieve_widgets()` function is soft deprecated to avoid unnecessary code churn downstream for developers that support more than the latest version of WordPress.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/18630">[18630]</a>.
Props zieladam, timothyblynjacobs, andraganescu, hellofromTonya.
See <a href="https://core.trac.wordpress.org/ticket/53811">#53811</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesupgradephp">trunk/src/wp-admin/includes/upgrade.php</a></li>
<li><a href="#trunksrcwpadminwidgetsformphp">trunk/src/wp-admin/widgets-form.php</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizewidgetsphp">trunk/src/wp-includes/class-wp-customize-widgets.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="#trunksrcwpincludesrestapiendpointsclasswprestwidgetscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-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="#trunktestsphpunittestswidgetsphp">trunk/tests/phpunit/tests/widgets.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesupgradephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/upgrade.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/upgrade.php 2021-08-31 18:57:09 UTC (rev 51704)
+++ trunk/src/wp-admin/includes/upgrade.php 2021-08-31 19:57:20 UTC (rev 51705)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1773,7 +1773,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Intentional fall-through to upgrade to the next version.
</span><span class="cx" style="display: block; padding: 0 10px"> case 2:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $sidebars_widgets = retrieve_widgets();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $sidebars_widgets = sync_registered_widgets();
</ins><span class="cx" style="display: block; padding: 0 10px"> $sidebars_widgets['array_version'] = 3;
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'sidebars_widgets', $sidebars_widgets );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpadminwidgetsformphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/widgets-form.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/widgets-form.php 2021-08-31 18:57:09 UTC (rev 51704)
+++ trunk/src/wp-admin/widgets-form.php 2021-08-31 19:57:20 UTC (rev 51705)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -118,7 +118,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-retrieve_widgets();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+sync_registered_widgets();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // We're saving a widget without JS.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $_POST['savewidget'] ) || isset( $_POST['removewidget'] ) ) {
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizewidgetsphp"></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/class-wp-customize-widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-widgets.php 2021-08-31 18:57:09 UTC (rev 51704)
+++ trunk/src/wp-includes/class-wp-customize-widgets.php 2021-08-31 19:57:20 UTC (rev 51705)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -275,9 +275,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'customize_value_old_sidebars_widgets_data', array( $this, 'filter_customize_value_old_sidebars_widgets_data' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->manager->set_post_value( 'old_sidebars_widgets_data', $this->old_sidebars_widgets ); // Override any value cached in changeset.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // retrieve_widgets() looks at the global $sidebars_widgets.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // sync_registered_widgets() looks at the global $sidebars_widgets.
</ins><span class="cx" style="display: block; padding: 0 10px"> $sidebars_widgets = $this->old_sidebars_widgets;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $sidebars_widgets = retrieve_widgets( 'customize' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $sidebars_widgets = sync_registered_widgets( 'customize' );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'option_sidebars_widgets', array( $this, 'filter_option_sidebars_widgets_for_theme_switch' ), 1 );
</span><span class="cx" style="display: block; padding: 0 10px"> // Reset global cache var used by wp_get_sidebars_widgets().
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $GLOBALS['_wp_sidebars_widgets'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -287,7 +287,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters old_sidebars_widgets_data Customizer setting.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * When switching themes, filter the Customizer setting old_sidebars_widgets_data
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * to supply initial $sidebars_widgets before they were overridden by retrieve_widgets().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * to supply initial $sidebars_widgets before they were overridden by sync_registered_widgets().
</ins><span class="cx" style="display: block; padding: 0 10px"> * The value for old_sidebars_widgets_data gets set in the old theme's sidebars_widgets
</span><span class="cx" style="display: block; padding: 0 10px"> * theme_mod.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -305,7 +305,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters sidebars_widgets option for theme switch.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * When switching themes, the retrieve_widgets() function is run when the Customizer initializes,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * When switching themes, the sync_registered_widgets() function is run when the Customizer initializes,
</ins><span class="cx" style="display: block; padding: 0 10px"> * and then the new sidebars_widgets here get supplied as the default value for the sidebars_widgets
</span><span class="cx" style="display: block; padding: 0 10px"> * option.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</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 2021-08-31 18:57:09 UTC (rev 51704)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php 2021-08-31 19:57:20 UTC (rev 51705)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -98,7 +98,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_items( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- retrieve_widgets();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sync_registered_widgets();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $data = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( wp_get_sidebars_widgets() as $id => $widgets ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -137,7 +137,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_item( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- retrieve_widgets();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sync_registered_widgets();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebar = $this->get_sidebar( $request['id'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestwidgetscontrollerphp"></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-widgets-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-widgets-controller.php 2021-08-31 18:57:09 UTC (rev 51704)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php 2021-08-31 19:57:20 UTC (rev 51705)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -109,7 +109,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_items( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- retrieve_widgets();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sync_registered_widgets();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -151,7 +151,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_item( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- retrieve_widgets();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sync_registered_widgets();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $widget_id = $request['id'];
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebar_id = wp_find_widgets_sidebar( $widget_id );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -237,7 +237,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_widget_factory;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * retrieve_widgets() contains logic to move "hidden" or "lost" widgets to the
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * sync_registered_widgets() contains logic to move "hidden" or "lost" widgets to the
</ins><span class="cx" style="display: block; padding: 0 10px"> * wp_inactive_widgets sidebar based on the contents of the $sidebars_widgets global.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * When batch requests are processed, this global is not properly updated by previous
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -248,7 +248,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> wp_get_sidebars_widgets();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- retrieve_widgets();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sync_registered_widgets();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $widget_id = $request['id'];
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebar_id = wp_find_widgets_sidebar( $widget_id );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -313,7 +313,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_widget_factory, $wp_registered_widget_updates;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * retrieve_widgets() contains logic to move "hidden" or "lost" widgets to the
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * sync_registered_widgets() contains logic to move "hidden" or "lost" widgets to the
</ins><span class="cx" style="display: block; padding: 0 10px"> * wp_inactive_widgets sidebar based on the contents of the $sidebars_widgets global.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * When batch requests are processed, this global is not properly updated by previous
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -324,7 +324,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> wp_get_sidebars_widgets();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- retrieve_widgets();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sync_registered_widgets();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $widget_id = $request['id'];
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebar_id = wp_find_widgets_sidebar( $widget_id );
</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 2021-08-31 18:57:09 UTC (rev 51704)
+++ trunk/src/wp-includes/theme.php 2021-08-31 19:57:20 UTC (rev 51705)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -805,7 +805,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_option( "theme_mods_$stylesheet", $default_theme_mods );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Since retrieve_widgets() is called when initializing a theme in the Customizer,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Since sync_registered_widgets() is called when initializing a theme in the Customizer,
</ins><span class="cx" style="display: block; padding: 0 10px"> * we need to remove the theme mods to avoid overwriting changes made via
</span><span class="cx" style="display: block; padding: 0 10px"> * the Customizer when accessing wp-admin/widgets.php.
</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 2021-08-31 18:57:09 UTC (rev 51704)
+++ trunk/src/wp-includes/widgets.php 2021-08-31 19:57:20 UTC (rev 51705)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1251,14 +1251,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebars_widgets = wp_get_sidebars_widgets();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- retrieve_widgets( true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sync_registered_widgets( true );
</ins><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Look for "lost" widgets, this has to run at least on each theme change.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Do not use, deprecated.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Use sync_registered_widgets() instead.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 5.8.1 Use sync_registered_widgets()
+ * @see sync_registered_widgets()
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|bool $theme_changed
+ * @return array
+ */
+function retrieve_widgets( $theme_changed = false ) {
+ return sync_registered_widgets( $theme_changed );
+}
+
+/**
+ * Looks for "lost" widgets and Updates widgets-to-sidebars allocation.
+ * This has to run at least on each theme change.
+ *
+ * @since 5.8.1
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_registered_sidebars Registered sidebars.
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $sidebars_widgets
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_registered_widgets Registered widgets.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1267,7 +1284,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * of 'customize' defers updates for the Customizer.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Updated sidebars widgets.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function retrieve_widgets( $theme_changed = false ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function sync_registered_widgets( $theme_changed = false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $registered_sidebars_keys = array_keys( $wp_registered_sidebars );
</span></span></pre></div>
<a id="trunktestsphpunittestswidgetsphp"></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/widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/widgets.php 2021-08-31 18:57:09 UTC (rev 51704)
+++ trunk/tests/phpunit/tests/widgets.php 2021-08-31 19:57:20 UTC (rev 51705)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -843,9 +843,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Tests for when 'sidebars_widgets' theme mod is populated.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers ::retrieve_widgets
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::sync_registered_widgets
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function test_retrieve_widgets_with_theme_mod() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_sync_registered_widgets_with_theme_mod() {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $sidebars_widgets, $_wp_sidebars_widgets;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_widgets_init();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -873,7 +873,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp_inactive_widgets' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = retrieve_widgets( true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = sync_registered_widgets( true );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertIsArray( $result );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $result, $sidebars_widgets );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -906,9 +906,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Tests for when sidebars widgets matches registered sidebars.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers ::retrieve_widgets
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::sync_registered_widgets
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function test_retrieve_widgets_with_sidebars_widgets_matching_registered_sidebars() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_sync_registered_widgets_with_sidebars_widgets_matching_registered_sidebars() {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $sidebars_widgets;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_widgets_init();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -921,7 +921,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp_inactive_widgets' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = retrieve_widgets( true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = sync_registered_widgets( true );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // $sidebars_widgets matches registered sidebars.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertIsArray( $result );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -944,9 +944,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Tests for when sidebars widgets doesn't match registered sidebars.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers ::retrieve_widgets
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::sync_registered_widgets
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function test_retrieve_widgets_with_sidebars_widgets_not_matching_registered_sidebars() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_sync_registered_widgets_with_sidebars_widgets_not_matching_registered_sidebars() {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $sidebars_widgets, $_wp_sidebars_widgets;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_widgets_init();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -960,7 +960,7 @@
</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"> // Theme changed.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = retrieve_widgets( true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = sync_registered_widgets( true );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $_wp_sidebars_widgets = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertIsArray( $result );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1002,7 +1002,7 @@
</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"> // Theme did not change.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = retrieve_widgets();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = sync_registered_widgets();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $_wp_sidebars_widgets = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertIsArray( $result );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1036,9 +1036,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Tests for Customizer mode.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers ::retrieve_widgets
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::sync_registered_widgets
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function test_retrieve_widgets_for_customizer() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_sync_registered_widgets_for_customizer() {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $sidebars_widgets, $_wp_sidebars_widgets;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_widgets_init();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1053,7 +1053,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> set_theme_mod( 'sidebars_widgets', $old_sidebars_widgets );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = retrieve_widgets( 'customize' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = sync_registered_widgets( 'customize' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $_wp_sidebars_widgets = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertIsArray( $result );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1082,7 +1082,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotEquals( $sidebars_widgets, wp_get_sidebars_widgets() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function test_retrieve_widgets_with_single_widget() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_sync_registered_widgets_with_single_widget() {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $sidebars_widgets;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_widgets_init();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1099,7 +1099,7 @@
</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"> // Theme changed.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = retrieve_widgets( true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = sync_registered_widgets( true );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( 'single', $result['wp_inactive_widgets'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1107,9 +1107,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Tests for orphaned widgets being moved into inactive widgets.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers ::retrieve_widgets
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::sync_registered_widgets
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function test_retrieve_widgets_move_orphaned_widgets_to_inactive() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_sync_registered_widgets_move_orphaned_widgets_to_inactive() {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $sidebars_widgets;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_widgets_init();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1122,7 +1122,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'orphaned_widgets_1' => array( 'calendar-1' ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- retrieve_widgets();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sync_registered_widgets();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertIsArray( $sidebars_widgets );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>