<!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>[39092] trunk: REST API: Add update and delete endpoints to /users/me</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/39092">39092</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/39092","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>rmccue</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-11-02 06:52:30 +0000 (Wed, 02 Nov 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: Add update and delete endpoints to /users/me
Now that /users/me is a standalone resource, it should have all the standard endpoints for a resource.
Props pento.
Fixes <a href="https://core.trac.wordpress.org/ticket/38521">#38521</a> (hopefully).</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestuserscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestuserscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-users-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestuserscontrollerphp"></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-users-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-users-controller.php 2016-11-02 06:27:29 UTC (rev 39091)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 2016-11-02 06:52:30 UTC (rev 39092)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -95,11 +95,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"> register_rest_route( $this->namespace, '/' . $this->rest_base . '/me', array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'methods' => WP_REST_Server::READABLE,
- 'callback' => array( $this, 'get_current_item' ),
- 'args' => array(
- 'context' => array(),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ array(
+ 'methods' => WP_REST_Server::READABLE,
+ 'callback' => array( $this, 'get_current_item' ),
+ 'args' => array(
+ 'context' => array(),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ array(
+ 'methods' => WP_REST_Server::EDITABLE,
+ 'callback' => array( $this, 'update_current_item' ),
+ 'permission_callback' => array( $this, 'update_current_item_permissions_check' ),
+ 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
+ ),
+ array(
+ 'methods' => WP_REST_Server::DELETABLE,
+ 'callback' => array( $this, 'delete_current_item' ),
+ 'permission_callback' => array( $this, 'delete_current_item_permissions_check' ),
+ 'args' => array(
+ 'force' => array(
+ 'default' => false,
+ 'description' => __( 'Required to be true, as resource does not support trashing.' ),
+ ),
+ 'reassign' => array(),
+ ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'schema' => array( $this, 'get_public_item_schema' ),
</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">@@ -568,6 +588,36 @@
</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 if a given request has access to update the current user.
+ *
+ * @since 4.7.0
+ * @access public
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has access to update the item, WP_Error object otherwise.
+ */
+ public function update_current_item_permissions_check( $request ) {
+ $request['id'] = get_current_user_id();
+
+ return $this->update_item_permissions_check( $request );
+ }
+
+ /**
+ * Updates the current user.
+ *
+ * @since 4.7.0
+ * @access public
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ function update_current_item( $request ) {
+ $request['id'] = get_current_user_id();
+
+ return $this->update_item( $request );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Checks if a given request has access delete a user.
</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">@@ -646,6 +696,36 @@
</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 if a given request has access to delete the current user.
+ *
+ * @since 4.7.0
+ * @access public
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has access to delete the item, WP_Error object otherwise.
+ */
+ public function delete_current_item_permissions_check( $request ) {
+ $request['id'] = get_current_user_id();
+
+ return $this->delete_item_permissions_check( $request );
+ }
+
+ /**
+ * Deletes the current user.
+ *
+ * @since 4.7.0
+ * @access public
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ function delete_current_item( $request ) {
+ $request['id'] = get_current_user_id();
+
+ return $this->delete_item( $request );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Prepares a single user output for response.
</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></pre></div>
<a id="trunktestsphpunittestsrestapirestuserscontrollerphp"></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-users-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-users-controller.php 2016-11-02 06:27:29 UTC (rev 39091)
+++ trunk/tests/phpunit/tests/rest-api/rest-users-controller.php 2016-11-02 06:52:30 UTC (rev 39092)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -956,6 +956,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $user = get_userdata( self::$editor );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'editor', $user->caps );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayNotHasKey( 'administrator', $user->caps );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/users/me' );
+ $request->set_param( 'roles', array( 'administrator' ) );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_cannot_edit_roles', $response, 403 );
+ $user = get_userdata( self::$editor );
+ $this->assertArrayHasKey( 'editor', $user->caps );
+ $this->assertArrayNotHasKey( 'administrator', $user->caps );
</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"> public function test_update_user_role_invalid_privilege_deescalation() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -976,6 +985,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $user = get_userdata( $user_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'administrator', $user->caps );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayNotHasKey( 'editor', $user->caps );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/users/me' );
+ $request->set_param( 'roles', array( 'editor' ) );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_user_invalid_role', $response, 403 );
+
+ $user = get_userdata( $user_id );
+ $this->assertArrayHasKey( 'administrator', $user->caps );
+ $this->assertArrayNotHasKey( 'editor', $user->caps );
</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"> public function test_update_user_role_privilege_deescalation_multisite() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -996,6 +1015,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $new_data = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'editor', $new_data['roles'][0] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotEquals( 'administrator', $new_data['roles'][0] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $user_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
+
+ wp_set_current_user( $user_id );
+ $user = wp_get_current_user();
+ update_site_option( 'site_admins', array( $user->user_login ) );
+
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/users/me' );
+ $request->set_param( 'roles', array( 'editor' ) );
+ $response = $this->server->dispatch( $request );
+
+ $new_data = $response->get_data();
+ $this->assertEquals( 'editor', $new_data['roles'][0] );
+ $this->assertNotEquals( 'administrator', $new_data['roles'][0] );
</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">@@ -1012,6 +1045,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $user = get_userdata( self::$editor );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'editor', $user->caps );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayNotHasKey( 'BeSharp', $user->caps );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/users/me' );
+ $request->set_param( 'roles', array( 'BeSharp' ) );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_user_invalid_role', $response, 400 );
+
+ $user = get_userdata( self::$editor );
+ $this->assertArrayHasKey( 'editor', $user->caps );
+ $this->assertArrayNotHasKey( 'BeSharp', $user->caps );
</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"> public function test_update_user_without_permission() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1029,6 +1072,13 @@
</span><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_cannot_edit', $response, 403 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/users/me' );
+ $request->add_header( 'content-type', 'application/x-www-form-urlencoded' );
+ $request->set_body_params( $params );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_user_invalid_argument', $response, 400 );
</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"> public function test_update_user_invalid_id() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1066,6 +1116,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'Deleted User', $data['name'] );
</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_current_item() {
+ $user_id = $this->factory->user->create( array( 'role' => 'administrator', 'display_name' => 'Deleted User' ) );
+
+ wp_set_current_user( $user_id );
+ $user = wp_get_current_user();
+ update_site_option( 'site_admins', array( $user->user_login ) );
+
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/users/me' );
+ $request['force'] = true;
+ $response = $this->server->dispatch( $request );
+
+ $this->assertEquals( 200, $response->get_status() );
+ $data = $response->get_data();
+ $this->assertEquals( 'Deleted User', $data['name'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_delete_item_no_trash() {
</span><span class="cx" style="display: block; padding: 0 10px"> $user_id = $this->factory->user->create( array( 'display_name' => 'Deleted User' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1082,6 +1148,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotEmpty( $user );
</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_current_item_no_trash() {
+ $user_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
+
+ wp_set_current_user( $user_id );
+ $user = wp_get_current_user();
+ update_site_option( 'site_admins', array( $user->user_login ) );
+
+ $userdata = get_userdata( $user_id ); // cache for later
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/users/me' );
+ $response = $this->server->dispatch( $request );
+ $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501 );
+
+ // Ensure the user still exists
+ $user = get_user_by( 'id', $user_id );
+ $this->assertNotEmpty( $user );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_delete_user_without_permission() {
</span><span class="cx" style="display: block; padding: 0 10px"> $user_id = $this->factory->user->create();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1093,6 +1176,12 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/users/me' );
+ $request['force'] = true;
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_user_cannot_delete', $response, 403 );
</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"> public function test_delete_user_invalid_id() {
</span></span></pre>
</div>
</div>
</body>
</html>