<!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>[40378] trunk: REST API: Allow fetching multiple users at once via the `slug` parameter.</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/40378">40378</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/40378","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jnylen0</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-04-05 22:24:24 +0000 (Wed, 05 Apr 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: Allow fetching multiple users at once via the `slug` parameter.
This matches similar changes previously made for posts (<a href="https://core.trac.wordpress.org/ticket/38579">#38579</a>) and terms (<a href="https://core.trac.wordpress.org/ticket/40027">#40027</a>).
Props curdin, MatheusGimenez.
Fixes <a href="https://core.trac.wordpress.org/ticket/40213">#40213</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 2017-04-05 21:07:04 UTC (rev 40377)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 2017-04-05 22:24:24 UTC (rev 40378)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -221,6 +221,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'per_page' => 'number',
</span><span class="cx" style="display: block; padding: 0 10px"> 'search' => 'search',
</span><span class="cx" style="display: block; padding: 0 10px"> 'roles' => 'role__in',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'slug' => 'nicename__in',
</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"> $prepared_args = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -261,12 +262,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $prepared_args['search'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_args['search'] = '*' . $prepared_args['search'] . '*';
</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 ( isset( $registered['slug'] ) && ! empty( $request['slug'] ) ) {
- $prepared_args['search'] = $request['slug'];
- $prepared_args['search_columns'] = array( 'user_nicename' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters WP_User_Query arguments when querying users via the REST API.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1363,8 +1358,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"> $query_params['slug'] = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'description' => __( 'Limit result set to users with a specific slug.' ),
- 'type' => 'string',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'description' => __( 'Limit result set to users with one or more specific slugs.' ),
+ 'type' => 'array',
+ 'items' => array(
+ '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"> $query_params['roles'] = array(
</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-04-05 21:07:04 UTC (rev 40377)
+++ trunk/tests/phpunit/tests/rest-api/rest-users-controller.php 2017-04-05 22:24:24 UTC (rev 40378)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -574,6 +574,68 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $id2, $data[0]['id'] );
</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_slug_array_query() {
+ wp_set_current_user( self::$user );
+ $id1 = $this->factory->user->create( array(
+ 'display_name' => 'Taco',
+ 'user_login' => 'taco'
+ ) );
+ $id2 = $this->factory->user->create( array(
+ 'display_name' => 'Enchilada',
+ 'user_login' => 'enchilada'
+ ) );
+ $id3 = $this->factory->user->create( array(
+ 'display_name' => 'Burrito',
+ 'user_login' => 'burrito'
+ ) );
+ $this->factory->user->create( array(
+ 'display_name' => 'Hon Pizza',
+ 'user_login' => 'pizza'
+ ) );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/users' );
+ $request->set_param( 'slug', array(
+ 'taco',
+ 'burrito',
+ 'enchilada',
+ ) );
+ $request->set_param( 'orderby', 'slug' );
+ $request->set_param( 'order', 'asc' );
+ $response = $this->server->dispatch( $request );
+ $this->assertEquals( 200, $response->get_status() );
+ $data = $response->get_data();
+ $slugs = wp_list_pluck( $data, 'slug' );
+ $this->assertEquals( array( 'burrito', 'enchilada', 'taco' ), $slugs );
+ }
+
+ public function test_get_items_slug_csv_query() {
+ wp_set_current_user( self::$user );
+ $id1 = $this->factory->user->create( array(
+ 'display_name' => 'Taco',
+ 'user_login' => 'taco'
+ ) );
+ $id2 = $this->factory->user->create( array(
+ 'display_name' => 'Enchilada',
+ 'user_login' => 'enchilada'
+ ) );
+ $id3 = $this->factory->user->create( array(
+ 'display_name' => 'Burrito',
+ 'user_login' => 'burrito'
+ ) );
+ $this->factory->user->create( array(
+ 'display_name' => 'Hon Pizza',
+ 'user_login' => 'pizza'
+ ) );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/users' );
+ $request->set_param( 'slug', 'taco,burrito , enchilada');
+ $request->set_param( 'orderby', 'slug' );
+ $request->set_param( 'order', 'desc' );
+ $response = $this->server->dispatch( $request );
+ $this->assertEquals( 200, $response->get_status() );
+ $data = $response->get_data();
+ $slugs = wp_list_pluck( $data, 'slug' );
+ $this->assertEquals( array( 'taco', 'enchilada', 'burrito' ), $slugs );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Note: Do not test using editor role as there is an editor role created in testing and it makes it hard to test this functionality.
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_items_roles() {
</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 2017-04-05 21:07:04 UTC (rev 40377)
+++ trunk/tests/qunit/fixtures/wp-api-generated.js 2017-04-05 22:24:24 UTC (rev 40378)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1989,7 +1989,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> "slug": {
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "description": "Limit result set to terms with a specific slug.",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "description": "Limit result set to terms with one or more specific slugs.",
</ins><span class="cx" style="display: block; padding: 0 10px"> "type": "array",
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -2227,7 +2227,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> "slug": {
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "description": "Limit result set to terms with a specific slug.",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "description": "Limit result set to terms with one or more specific slugs.",
</ins><span class="cx" style="display: block; padding: 0 10px"> "type": "array",
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -2444,8 +2444,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> "slug": {
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "description": "Limit result set to users with a specific slug.",
- "type": "string"
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "description": "Limit result set to users with one or more specific slugs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> "roles": {
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false,
</span></span></pre>
</div>
</div>
</body>
</html>