<!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>[43001] trunk: REST API: Add `who=authors` as a query parameter for `GET wp/v2/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 { 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/43001">43001</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/43001","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>2018-04-25 13:05:48 +0000 (Wed, 25 Apr 2018)</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 `who=authors` as a query parameter for `GET wp/v2/users`.
Any WordPress user who can `edit_posts` of a post type with `show_in_rest=true` can query for authors. This maps to current WordPress behavior where a WordPress user who can view the Manage Posts view for a post type can see any WordPress user assigned to a post (whether published or draft).
This implementation, over restricting `who=authors` to users with `list_users`, gives us future flexibility in displaying lists of posts. It still respects more restrictive permissions for `context=edit`.
Props danielbachhuber.
Fixes <a href="https://core.trac.wordpress.org/ticket/42202">#42202</a>.</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>
<li><a href="#trunktestsqunitfixtureswpapigeneratedjs">trunk/tests/qunit/fixtures/wp-api-generated.js</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 2018-04-24 21:34:59 UTC (rev 43000)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 2018-04-25 13:05:48 UTC (rev 43001)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -192,6 +192,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_forbidden_orderby', __( 'Sorry, you are not allowed to order users by this parameter.' ), array( 'status' => rest_authorization_required_code() ) );
</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">+ if ( 'authors' === $request['who'] ) {
+ $can_view = false;
+ $types = get_post_types( array( 'show_in_rest' => true ), 'objects' );
+ foreach ( $types as $type ) {
+ if ( current_user_can( $type->cap->edit_posts ) ) {
+ $can_view = true;
+ }
+ }
+ if ( ! $can_view ) {
+ return new WP_Error( 'rest_forbidden_who', __( 'Sorry, you are not allowed to query users by this parameter.' ), array( 'status' => rest_authorization_required_code() ) );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</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">@@ -256,7 +269,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_args['orderby'] = $orderby_possibles[ $request['orderby'] ];
</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">- if ( ! current_user_can( 'list_users' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $registered['who'] ) && ! empty( $request['who'] ) && 'authors' === $request['who'] ) {
+ $prepared_args['who'] = 'authors';
+ } elseif ( ! current_user_can( 'list_users' ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $prepared_args['has_published_posts'] = get_post_types( array( 'show_in_rest' => true ), 'names' );
</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">@@ -1372,6 +1387,14 @@
</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">+ $query_params['who'] = array(
+ 'description' => __( 'Limit result set to users who are considered authors.' ),
+ 'type' => 'string',
+ 'enum' => array(
+ 'authors',
+ ),
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filter collection parameters for the users controller.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</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 2018-04-24 21:34:59 UTC (rev 43000)
+++ trunk/tests/phpunit/tests/rest-api/rest-users-controller.php 2018-04-25 13:05:48 UTC (rev 43001)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -14,6 +14,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $user;
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $editor;
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $draft_editor;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected static $subscriber;
</ins><span class="cx" style="display: block; padding: 0 10px"> protected static $authors = array();
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $posts = array();
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $site;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -42,6 +43,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_email' => 'draft-editor@example.com',
</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">+ self::$subscriber = $factory->user->create(
+ array(
+ 'role' => 'subscriber',
+ 'display_name' => 'subscriber',
+ 'user_email' => 'subscriber@example.com',
+ )
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( array( true, false ) as $show_in_rest ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( array( true, false ) as $public ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -166,6 +174,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'roles',
</span><span class="cx" style="display: block; padding: 0 10px"> 'search',
</span><span class="cx" style="display: block; padding: 0 10px"> 'slug',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'who',
</ins><span class="cx" style="display: block; padding: 0 10px"> ), $keys
</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">@@ -280,7 +289,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'GET', '/wp/v2/users' );
</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"> $headers = $response->get_headers();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 53, $headers['X-WP-Total'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 54, $headers['X-WP-Total'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 6, $headers['X-WP-TotalPages'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $next_link = add_query_arg(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -299,7 +308,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'page', 3 );
</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"> $headers = $response->get_headers();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 54, $headers['X-WP-Total'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 55, $headers['X-WP-Total'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 6, $headers['X-WP-TotalPages'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $prev_link = add_query_arg(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -318,7 +327,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'page', 6 );
</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"> $headers = $response->get_headers();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 54, $headers['X-WP-Total'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 55, $headers['X-WP-Total'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 6, $headers['X-WP-TotalPages'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $prev_link = add_query_arg(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -332,7 +341,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'page', 8 );
</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"> $headers = $response->get_headers();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 54, $headers['X-WP-Total'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 55, $headers['X-WP-Total'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 6, $headers['X-WP-TotalPages'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $prev_link = add_query_arg(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -525,12 +534,12 @@
</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_offset() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$user );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 7 users created in wpSetUpBeforeClass(), plus default user.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 9 users created in wpSetUpBeforeClass(), plus default user.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->factory->user->create();
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'GET', '/wp/v2/users' );
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'offset', 1 );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_server()->dispatch( $request );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertCount( 9, $response->get_data() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertCount( 10, $response->get_data() );
</ins><span class="cx" style="display: block; padding: 0 10px"> // 'offset' works with 'per_page'
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'per_page', 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_server()->dispatch( $request );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -744,9 +753,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'roles', 'author,subscriber' );
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 2, count( $data ) );
- $this->assertEquals( $tango, $data[0]['id'] );
- $this->assertEquals( $yolo, $data[1]['id'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 3, count( $data ) );
+ $this->assertEquals( $tango, $data[1]['id'] );
+ $this->assertEquals( $yolo, $data[2]['id'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'roles', 'author' );
</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">@@ -784,6 +793,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array(), $data );
</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_get_items_who_author_query() {
+ wp_set_current_user( self::$superadmin );
+ // First request should include subscriber in the set.
+ $request = new WP_REST_Request( 'GET', '/wp/v2/users' );
+ $request->set_param( 'search', 'subscriber' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertEquals( 200, $response->get_status() );
+ $this->assertCount( 1, $response->get_data() );
+ // Second request should exclude subscriber.
+ $request = new WP_REST_Request( 'GET', '/wp/v2/users' );
+ $request->set_param( 'who', 'authors' );
+ $request->set_param( 'search', 'subscriber' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertEquals( 200, $response->get_status() );
+ $this->assertCount( 0, $response->get_data() );
+ }
+
+ public function test_get_items_who_invalid_query() {
+ wp_set_current_user( self::$user );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/users' );
+ $request->set_param( 'who', 'editor' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+ }
+
+ /**
+ * Any user with 'edit_posts' on a show_in_rest post type
+ * can view authors. Others (e.g. subscribers) cannot.
+ */
+ public function test_get_items_who_unauthorized_query() {
+ wp_set_current_user( self::$subscriber );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/users' );
+ $request->set_param( 'who', 'authors' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_forbidden_who', $response, 403 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_item() {
</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"> wp_set_current_user( self::$user );
</span></span></pre></div>
<a id="trunktestsqunitfixtureswpapigeneratedjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/fixtures/wp-api-generated.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/fixtures/wp-api-generated.js 2018-04-24 21:34:59 UTC (rev 43000)
+++ trunk/tests/qunit/fixtures/wp-api-generated.js 2018-04-25 13:05:48 UTC (rev 43001)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2512,6 +2512,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "items": {
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "string"
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ },
+ "who": {
+ "required": false,
+ "enum": [
+ "authors"
+ ],
+ "description": "Limit result set to users who are considered authors.",
+ "type": "string"
</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></pre>
</div>
</div>
</body>
</html>