<!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>[51277] trunk: REST API: Allow multiple widgets to be deleted in a single batch request.</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/51277">51277</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/51277","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-06-30 10:40:21 +0000 (Wed, 30 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: Allow multiple widgets to be deleted in a single batch request.
This resets the `WP_Widget::$updated` flag when deleting a widget, to avoid blocking all future updates in a request.
Props noisysocks, andraganescu.
Fixes <a href="https://core.trac.wordpress.org/ticket/53557">#53557</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestwidgetscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestwidgetscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-widgets-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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-06-30 04:59:10 UTC (rev 51276)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php 2021-06-30 10:40:21 UTC (rev 51277)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -289,13 +289,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $wp_registered_widget_updates The registered widget update functions.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_registered_widget_updates The registered widget update functions.
+ * @global WP_Widget_Factory $wp_widget_factory
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Full details about the request.
</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 delete_item( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $wp_registered_widget_updates;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $wp_registered_widget_updates, $wp_widget_factory;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> retrieve_widgets();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -344,6 +345,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $_POST = $original_post;
</span><span class="cx" style="display: block; padding: 0 10px"> $_REQUEST = $original_request;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $widget_object = $wp_widget_factory->get_widget_object( $id_base );
+
+ if ( $widget_object ) {
+ /*
+ * WP_Widget sets `updated = true` after an update to prevent more than one widget
+ * from being saved per request. This isn't what we want in the REST API, though,
+ * as we support batch requests.
+ */
+ $widget_object->updated = false;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_assign_widget_to_sidebar( $widget_id, '' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $response->set_data(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -520,9 +532,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $widget_object->_set( $number );
</span><span class="cx" style="display: block; padding: 0 10px"> $widget_object->_register_one( $number );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // WP_Widget sets updated = true after an update to prevent more
- // than one widget from being saved per request. This isn't what we
- // want in the REST API, though, as we support batch requests.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * WP_Widget sets `updated = true` after an update to prevent more than one widget
+ * from being saved per request. This isn't what we want in the REST API, though,
+ * as we support batch requests.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $widget_object->updated = false;
</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="trunktestsphpunittestsrestapirestwidgetscontrollerphp"></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-widgets-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-widgets-controller.php 2021-06-30 04:59:10 UTC (rev 51276)
+++ trunk/tests/phpunit/tests/rest-api/rest-widgets-controller.php 2021-06-30 10:40:21 UTC (rev 51277)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -165,19 +165,20 @@
</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"> private function setup_widget( $id_base, $number, $settings ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->setup_widgets( $id_base, array( $number => $settings ) );
+ }
+
+ private function setup_widgets( $id_base, $settings ) {
</ins><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"> $option_name = "widget_$id_base";
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- update_option(
- $option_name,
- array(
- $number => $settings,
- )
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ update_option( $option_name, $settings );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $widget_object = $wp_widget_factory->get_widget_object( $id_base );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $widget_object->_set( $number );
- $widget_object->_register_one( $number );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( array_keys( $settings ) as $number ) {
+ $widget_object->_set( $number );
+ $widget_object->_register_one( $number );
+ }
</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"> private function setup_sidebar( $id, $attrs = array(), $widgets = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1379,6 +1380,61 @@
</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 53557
+ */
+ public function test_delete_item_multiple() {
+ $this->setup_widgets(
+ 'text',
+ array(
+ 2 => array( 'text' => 'Text widget' ),
+ 3 => array( 'text' => 'Text widget' ),
+ 4 => array( 'text' => 'Text widget' ),
+ )
+ );
+ $this->setup_sidebar(
+ 'sidebar-1',
+ array(
+ 'name' => 'Test sidebar',
+ ),
+ array( 'text-2', 'text-3', 'text-4' )
+ );
+
+ $request = new WP_REST_Request( 'POST', '/batch/v1' );
+ $request->set_body_params(
+ array(
+ 'requests' => array(
+ array(
+ 'method' => 'DELETE',
+ 'path' => '/wp/v2/widgets/text-2?force=1',
+ ),
+ array(
+ 'method' => 'DELETE',
+ 'path' => '/wp/v2/widgets/text-3?force=1',
+ ),
+ array(
+ 'method' => 'DELETE',
+ 'path' => '/wp/v2/widgets/text-4?force=1',
+ ),
+ ),
+ )
+ );
+ $response = rest_do_request( $request );
+
+ $this->assertSame(
+ array(
+ 'sidebar-1' => array(),
+ ),
+ wp_get_sidebars_widgets()
+ );
+ $this->assertSame(
+ array(
+ '_multiwidget' => 1,
+ ),
+ get_option( 'widget_text' )
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * The test_prepare_item() method does not exist for sidebar.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_prepare_item() {
</span></span></pre>
</div>
</div>
</body>
</html>