<!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>[39843] trunk: REST API: Change which users are shown in the users endpoint.</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/39843">39843</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/39843","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>aaroncampbell</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-01-11 14:13:48 +0000 (Wed, 11 Jan 2017)</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: Change which users are shown in the users endpoint.
Only show users that have authored a post of a post type that has `show_in_rest` set to true.
Props rachelbaker, jnylen0.
See <a href="https://core.trac.wordpress.org/ticket/38878">#38878</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>
</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 2017-01-11 13:21:01 UTC (rev 39842)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 2017-01-11 14:13:48 UTC (rev 39843)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -249,7 +249,7 @@
</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"> if ( ! current_user_can( 'list_users' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $prepared_args['has_published_posts'] = true;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $prepared_args['has_published_posts'] = get_post_types( array( 'show_in_rest' => true ), 'names' );
</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"> if ( ! empty( $prepared_args['search'] ) ) {
</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 2017-01-11 13:21:01 UTC (rev 39842)
+++ trunk/tests/phpunit/tests/rest-api/rest-users-controller.php 2017-01-11 14:13:48 UTC (rev 39843)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13,6 +13,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $superadmin;
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected static $editor2;
+ protected static $secret_editor;
+ protected static $secret_editor2;
</ins><span class="cx" style="display: block; padding: 0 10px"> protected static $site;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public static function wpSetUpBeforeClass( $factory ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -27,6 +30,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'role' => 'editor',
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_email' => 'editor@example.com',
</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::$editor2 = $factory->user->create( array(
+ 'role' => 'editor',
+ 'user_email' => 'editor2@example.com',
+ ) );
+ self::$secret_editor = $factory->user->create( array(
+ 'role' => 'editor',
+ 'user_email' => 'secret_editor@example.com',
+ ) );
+ self::$secret_editor2 = $factory->user->create( array(
+ 'role' => 'editor',
+ 'user_email' => 'secret_editor2@example.com',
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_multisite() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> self::$site = $factory->blog->create( array( 'domain' => 'rest.wordpress.org', 'path' => '/' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -37,6 +52,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public static function wpTearDownAfterClass() {
</span><span class="cx" style="display: block; padding: 0 10px"> self::delete_user( self::$user );
</span><span class="cx" style="display: block; padding: 0 10px"> self::delete_user( self::$editor );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::delete_user( self::$editor2 );
+ self::delete_user( self::$secret_editor );
+ self::delete_user( self::$secret_editor2 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_multisite() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wpmu_delete_blog( self::$site, true );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -48,6 +66,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function setUp() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::setUp();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ register_post_type( 'rest_public', array( 'public' => true, 'show_in_rest' => true ) );
+ register_post_type( 'secret_public', array( 'public' => true, 'show_in_rest' => false ) );
+ register_post_type( 'secret_hidden', array( 'public' => false, 'show_in_rest' => false ) );
+ register_post_type( 'rest_hidden', array( 'public' => false, 'show_in_rest' => true ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->endpoint = new WP_REST_Users_Controller();
</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">@@ -144,33 +168,92 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 403, $response->get_status() );
</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">- public function test_get_items_unauthenticated_only_shows_public_users() {
- $request = new WP_REST_Request( 'GET', '/wp/v2/users' );
- $response = $this->server->dispatch( $request );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_get_items_unauthenticated_includes_authors_of_post_types_shown_in_rest() {
+ $created_posts = array();
+ $created_posts[] = $this->factory->post->create( array(
+ 'post_author' => self::$user,
+ 'post_status' => 'publish',
+ ) );
+ // Expose authors if show_in_rest is true, even if the post_type is not public.
+ $created_posts[] = $this->factory->post->create( array(
+ 'post_type' => 'rest_hidden',
+ 'post_author' => self::$editor,
+ 'post_status' => 'publish',
+ ) );
+ $created_posts[] = $this->factory->post->create( array(
+ 'post_type' => 'rest_public',
+ 'post_author' => self::$editor2,
+ 'post_status' => 'publish',
+ ) );
+ $created_posts[] = $this->factory->post->create( array(
+ 'post_type' => 'rest_public',
+ 'post_author' => self::$secret_editor,
+ 'post_status' => 'draft',
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( array(), $response->get_data() );
-
- $this->factory->post->create( array( 'post_author' => self::$editor ) );
- $this->factory->post->create( array( 'post_author' => self::$user, 'post_status' => 'draft' ) );
-
</del><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 = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $users = $response->get_data();
</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_post_types = array_values( get_post_types( array( 'show_in_rest' => true ), 'names' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $users as $user ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertTrue( count_user_posts( $user['id'] ) > 0 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertTrue( count_user_posts( $user['id'], $public_post_types ) > 0 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Ensure we don't expose non-public data
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Ensure we don't expose non-public data.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayNotHasKey( 'capabilities', $user );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayNotHasKey( 'registered_date', $user );
+ $this->assertArrayNotHasKey( 'first_name', $user );
+ $this->assertArrayNotHasKey( 'last_name', $user );
+ $this->assertArrayNotHasKey( 'nickname', $user );
+ $this->assertArrayNotHasKey( 'extra_capabilities', $user );
+ $this->assertArrayNotHasKey( 'username', $user );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayNotHasKey( 'email', $user );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayNotHasKey( 'roles', $user );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayNotHasKey( 'locale', $user );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $this->assertTrue( in_array( self::$user, wp_list_pluck( $users, 'id' ), true ) );
+ $this->assertTrue( in_array( self::$editor, wp_list_pluck( $users, 'id' ), true ) );
+ $this->assertTrue( in_array( self::$editor2, wp_list_pluck( $users, 'id' ), true ) );
+
+ // Do not include authors of unpublished posts.
+ $this->assertFalse( in_array( self::$secret_editor, wp_list_pluck( $users, 'id' ), true ) );
+
+ foreach ( $created_posts as $post_id ) {
+ wp_delete_post( $post_id, true );
+ }
</ins><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_unauthenticated_does_not_include_authors_of_post_types_not_shown_in_rest() {
+ $created_posts = array();
+ $created_posts[] = $this->factory->post->create( array(
+ 'post_type' => 'secret_hidden',
+ 'post_author' => self::$secret_editor,
+ 'post_status' => 'publish',
+ ) );
+ $created_posts[] = $this->factory->post->create( array(
+ 'post_type' => 'secret_public',
+ 'post_author' => self::$secret_editor2,
+ 'post_status' => 'publish',
+ ) );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/users' );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertFalse( in_array( self::$secret_editor, wp_list_pluck( $data, 'id' ), true ) );
+ $this->assertFalse( in_array( self::$secret_editor2, wp_list_pluck( $data, 'id' ), true ) );
+
+ foreach ( $created_posts as $post_id ) {
+ wp_delete_post( $post_id, true );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_items_pagination_headers() {
</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">- // Start of the index, including the three existing users
- for ( $i = 0; $i < 47; $i++ ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Start of the index, including the six existing users.
+ for ( $i = 0; $i < 44; $i++ ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->factory->user->create( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => "User {$i}",
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -391,12 +474,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">- // 2 users created in __construct(), plus default user
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 5 users created in __construct(), 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 = $this->server->dispatch( $request );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertCount( 4, $response->get_data() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertCount( 7, $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 = $this->server->dispatch( $request );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2083,6 +2166,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"> public function tearDown() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _unregister_post_type( 'rest_public' );
+ _unregister_post_type( 'secret_public' );
+ _unregister_post_type( 'secret_hidden' );
+ _unregister_post_type( 'rest_hidden' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> parent::tearDown();
</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>