<!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>[39427] branches/4.7: REST API: Require the reassign parameter when deleting users.</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 { 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/39427">39427</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/39427","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>pento</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-12-02 06:58:36 +0000 (Fri, 02 Dec 2016)</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: Require the reassign parameter when deleting users.
When deleting a user through the WordPress admin, a specific decision is presented - whether to assign all of the user's posts to another user, or to delete all of the posts.
This change requires `reassign` as a parameter in the corresponding REST API endpoint, so that content isn't accidentally lost.
Merges <a href="https://core.trac.wordpress.org/changeset/39426">[39426]</a> to the 4.7 branch.
Props jeremyfelt.
Fixes <a href="https://core.trac.wordpress.org/ticket/39000">#39000</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches47srcwpincludesrestapiendpointsclasswprestuserscontrollerphp">branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php</a></li>
<li><a href="#branches47testsphpunittestsrestapirestuserscontrollerphp">branches/4.7/tests/phpunit/tests/rest-api/rest-users-controller.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches47">branches/4.7/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/4.7
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/4.7 2016-12-02 06:53:59 UTC (rev 39426)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/4.7 2016-12-02 06:58:36 UTC (rev 39427)
</ins><a id="branches47"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/4.7</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.1:18031
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.3:20543
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:18512,39365,39369,39371,39373,39375-39376,39378,39380,39382,39384,39386,39388,39390,39392-39393,39396-39397,39400,39402,39404,39406,39409,39411,39413,39415,39417-39419,39424
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:18512,39365,39369,39371,39373,39375-39376,39378,39380,39382,39384,39386,39388,39390,39392-39393,39396-39397,39400,39402,39404,39406,39409,39411,39413,39415,39417-39419,39424,39426
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches47srcwpincludesrestapiendpointsclasswprestuserscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 2016-12-02 06:53:59 UTC (rev 39426)
+++ branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 2016-12-02 06:58:36 UTC (rev 39427)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -92,6 +92,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'reassign' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'integer',
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Reassign the deleted user\'s posts and links to this user ID.' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'required' => true,
+ 'sanitize_callback' => array( $this, 'check_reassign' ),
</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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -125,6 +127,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'reassign' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'integer',
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Reassign the deleted user\'s posts and links to this user ID.' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'required' => true,
+ 'sanitize_callback' => array( $this, 'check_reassign' ),
</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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -133,6 +137,31 @@
</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">+ * Checks for a valid value for the reassign parameter when deleting users.
+ *
+ * The value can be an integer, 'false', false, or ''.
+ *
+ * @since 4.7.0
+ *
+ * @param int|bool $value The value passed to the reassign parameter.
+ * @param WP_REST_Request $request Full details about the request.
+ * @param string $param The parameter that is being sanitized.
+ *
+ * @return int|bool|WP_Error
+ */
+ public function check_reassign( $value, $request, $param ) {
+ if ( is_numeric( $value ) ) {
+ return $value;
+ }
+
+ if ( empty( $value ) || false === $value || 'false' === $value ) {
+ return false;
+ }
+
+ return new WP_Error( 'rest_invalid_param', __( 'Invalid user parameter(s).' ), array( 'status' => 400 ) );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Permissions check for getting all users.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -673,7 +702,7 @@
</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><span class="cx" style="display: block; padding: 0 10px"> $id = (int) $request['id'];
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $reassign = isset( $request['reassign'] ) ? absint( $request['reassign'] ) : null;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $reassign = false === $request['reassign'] ? null : absint( $request['reassign'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $force = isset( $request['force'] ) ? (bool) $request['force'] : false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // We don't support trashing for users.
</span></span></pre></div>
<a id="branches47testsphpunittestsrestapirestuserscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.7/tests/phpunit/tests/rest-api/rest-users-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.7/tests/phpunit/tests/rest-api/rest-users-controller.php 2016-12-02 06:53:59 UTC (rev 39426)
+++ branches/4.7/tests/phpunit/tests/rest-api/rest-users-controller.php 2016-12-02 06:58:36 UTC (rev 39427)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1639,7 +1639,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $userdata = get_userdata( $user_id ); // cache for later
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'DELETE', sprintf( '/wp/v2/users/%d', $user_id ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $request['force'] = true;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_param( 'force', true );
+ $request->set_param( 'reassign', false );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 200, $response->get_status() );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1657,6 +1658,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $userdata = get_userdata( $user_id ); // cache for later
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'DELETE', sprintf( '/wp/v2/users/%d', $user_id ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_param( 'reassign', false );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1678,6 +1680,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'DELETE', '/wp/v2/users/me' );
</span><span class="cx" style="display: block; padding: 0 10px"> $request['force'] = true;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_param( 'reassign', false );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 200, $response->get_status() );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1694,6 +1697,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> update_site_option( 'site_admins', array( $user->user_login ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'DELETE', '/wp/v2/users/me' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_param( 'reassign', false );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1714,12 +1718,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'DELETE', sprintf( '/wp/v2/users/%d', $user_id ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $request['force'] = true;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_param( 'reassign', false );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_user_cannot_delete', $response, 403 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'DELETE', '/wp/v2/users/me' );
</span><span class="cx" style="display: block; padding: 0 10px"> $request['force'] = true;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_param( 'reassign', false );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_user_cannot_delete', $response, 403 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1731,6 +1737,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'DELETE', '/wp/v2/users/100' );
</span><span class="cx" style="display: block; padding: 0 10px"> $request['force'] = true;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_param( 'reassign', false );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_user_invalid_id', $response, 404 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1778,6 +1785,96 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_user_invalid_reassign', $response, 400 );
</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">+ public function test_delete_user_invalid_reassign_passed_as_string() {
+ $user_id = $this->factory->user->create();
+
+ $this->allow_user_to_manage_multisite();
+ wp_set_current_user( self::$user );
+
+ $request = new WP_REST_Request( 'DELETE', sprintf( '/wp/v2/users/%d', $user_id ) );
+ $request['force'] = true;
+ $request->set_param( 'reassign', 'null' );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+ }
+
+ public function test_delete_user_reassign_passed_as_boolean_false_trashes_post() {
+ $user_id = $this->factory->user->create();
+
+ $this->allow_user_to_manage_multisite();
+ wp_set_current_user( self::$user );
+
+ $test_post = $this->factory->post->create(array(
+ 'post_author' => $user_id,
+ ));
+
+ $request = new WP_REST_Request( 'DELETE', sprintf( '/wp/v2/users/%d', $user_id ) );
+ $request['force'] = true;
+ $request->set_param( 'reassign', false );
+ $this->server->dispatch( $request );
+
+ $test_post = get_post( $test_post );
+ $this->assertEquals( 'trash', $test_post->post_status );
+ }
+
+ public function test_delete_user_reassign_passed_as_string_false_trashes_post() {
+ $user_id = $this->factory->user->create();
+
+ $this->allow_user_to_manage_multisite();
+ wp_set_current_user( self::$user );
+
+ $test_post = $this->factory->post->create(array(
+ 'post_author' => $user_id,
+ ));
+
+ $request = new WP_REST_Request( 'DELETE', sprintf( '/wp/v2/users/%d', $user_id ) );
+ $request['force'] = true;
+ $request->set_param( 'reassign', 'false' );
+ $this->server->dispatch( $request );
+
+ $test_post = get_post( $test_post );
+ $this->assertEquals( 'trash', $test_post->post_status );
+ }
+
+ public function test_delete_user_reassign_passed_as_empty_string_trashes_post() {
+ $user_id = $this->factory->user->create();
+
+ $this->allow_user_to_manage_multisite();
+ wp_set_current_user( self::$user );
+
+ $test_post = $this->factory->post->create(array(
+ 'post_author' => $user_id,
+ ));
+
+ $request = new WP_REST_Request( 'DELETE', sprintf( '/wp/v2/users/%d', $user_id ) );
+ $request['force'] = true;
+ $request->set_param( 'reassign', '' );
+ $this->server->dispatch( $request );
+
+ $test_post = get_post( $test_post );
+ $this->assertEquals( 'trash', $test_post->post_status );
+ }
+
+ public function test_delete_user_reassign_passed_as_0_reassigns_author() {
+ $user_id = $this->factory->user->create();
+
+ $this->allow_user_to_manage_multisite();
+ wp_set_current_user( self::$user );
+
+ $test_post = $this->factory->post->create(array(
+ 'post_author' => $user_id,
+ ));
+
+ $request = new WP_REST_Request( 'DELETE', sprintf( '/wp/v2/users/%d', $user_id ) );
+ $request['force'] = true;
+ $request->set_param( 'reassign', 0 );
+ $this->server->dispatch( $request );
+
+ $test_post = get_post( $test_post );
+ $this->assertEquals( 0, $test_post->post_author );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_item_schema() {
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/users' );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span></span></pre>
</div>
</div>
</body>
</html>