<!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>[51235] trunk: REST API: Retrieve latest widgets before loading sidebars.</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/51235">51235</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/51235","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>TimothyBlynJacobs</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-06-25 13:17:20 +0000 (Fri, 25 Jun 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'>REST API: Retrieve latest widgets before loading sidebars.
This fixes issues where sidebars would be unexpectedly missing from the new widgets screen. Running retrieve_widgets syncs sidebars that were registered after the last theme switch.
Props walbo, hellofromTonya, noisysocks.
Fixes <a href="https://core.trac.wordpress.org/ticket/53489">#53489</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestsidebarscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestsidebarscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-sidebars-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestwidgettypescontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-widget-types-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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-06-25 10:38:23 UTC (rev 51234)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php 2021-06-25 13:17:20 UTC (rev 51235)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -98,8 +98,10 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ retrieve_widgets();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $data = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( (array) wp_get_sidebars_widgets() as $id => $widgets ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( wp_get_sidebars_widgets() as $id => $widgets ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $sidebar = $this->get_sidebar( $id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $sidebar ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -135,6 +137,8 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ retrieve_widgets();
+
</ins><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 class="cx" style="display: block; padding: 0 10px"> if ( ! $sidebar ) {
</span></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 2021-06-25 10:38:23 UTC (rev 51234)
+++ trunk/tests/phpunit/tests/rest-api/rest-sidebars-controller.php 2021-06-25 13:17:20 UTC (rev 51235)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,10 +8,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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Tests for REST API for Menus.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Tests for REST API for Widgets.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Test_REST_Controller_Testcase
</span><span class="cx" style="display: block; padding: 0 10px"> * @group restapi
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group widgets
</ins><span class="cx" style="display: block; padding: 0 10px"> * @covers WP_REST_Sidebars_Controller
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class WP_Test_REST_Sidebars_Controller extends WP_Test_REST_Controller_Testcase {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -61,6 +62,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'sidebars_widgets', array() );
</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">+ function clean_up_global_scope() {
+ global $wp_widget_factory, $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates;
+
+ $wp_registered_sidebars = array();
+ $wp_registered_widgets = array();
+ $wp_registered_widget_controls = array();
+ $wp_registered_widget_updates = array();
+ $wp_widget_factory->widgets = array();
+
+ parent::clean_up_global_scope();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> private function setup_widget( $option_name, $number, $settings ) {
</span><span class="cx" style="display: block; padding: 0 10px"> update_option(
</span><span class="cx" style="display: block; padding: 0 10px"> $option_name,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -128,6 +141,8 @@
</span><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_get_items() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_widgets_init();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'GET', '/wp/v2/sidebars' );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_server()->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -193,6 +208,8 @@
</span><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_get_items_active_sidebar_with_widgets() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_widgets_init();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->setup_widget(
</span><span class="cx" style="display: block; padding: 0 10px"> 'widget_rss',
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -242,6 +259,56 @@
</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 53489
+ */
+ public function test_get_items_when_registering_new_sidebars() {
+ register_sidebar(
+ array(
+ 'name' => 'New Sidebar',
+ 'id' => 'new-sidebar',
+ 'before_widget' => '',
+ 'after_widget' => '',
+ 'before_title' => '',
+ 'after_title' => '',
+ )
+ );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/sidebars' );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+ $data = $this->remove_links( $data );
+ $this->assertSame(
+ array(
+ array(
+ 'id' => 'wp_inactive_widgets',
+ 'name' => 'Inactive widgets',
+ 'description' => '',
+ 'class' => '',
+ 'before_widget' => '',
+ 'after_widget' => '',
+ 'before_title' => '',
+ 'after_title' => '',
+ 'status' => 'inactive',
+ 'widgets' => array(),
+ ),
+ array(
+ 'id' => 'new-sidebar',
+ 'name' => 'New Sidebar',
+ 'description' => '',
+ 'class' => '',
+ 'before_widget' => '',
+ 'after_widget' => '',
+ 'before_title' => '',
+ 'after_title' => '',
+ 'status' => 'active',
+ 'widgets' => array(),
+ ),
+ ),
+ $data
+ );
+ }
+
+ /**
</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_get_item() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -317,6 +384,8 @@
</span><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() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_widgets_init();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->setup_widget(
</span><span class="cx" style="display: block; padding: 0 10px"> 'widget_rss',
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -382,6 +451,8 @@
</span><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_removes_widget_from_existing_sidebar() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_widgets_init();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->setup_widget(
</span><span class="cx" style="display: block; padding: 0 10px"> 'widget_text',
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -423,6 +494,8 @@
</span><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_moves_omitted_widget_to_inactive_sidebar() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_widgets_init();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->setup_widget(
</span><span class="cx" style="display: block; padding: 0 10px"> 'widget_text',
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -465,6 +538,8 @@
</span><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_get_items_inactive_widgets() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_widgets_init();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->setup_widget(
</span><span class="cx" style="display: block; padding: 0 10px"> 'widget_rss',
</span><span class="cx" style="display: block; padding: 0 10px"> 1,
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestwidgettypescontrollerphp"></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-widget-types-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-widget-types-controller.php 2021-06-25 10:38:23 UTC (rev 51234)
+++ trunk/tests/phpunit/tests/rest-api/rest-widget-types-controller.php 2021-06-25 13:17:20 UTC (rev 51235)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -112,6 +112,7 @@
</span><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_get_items() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_widgets_init();
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$admin_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'GET', '/wp/v2/widget-types' );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_server()->dispatch( $request );
</span></span></pre>
</div>
</div>
</body>
</html>