Changeset 40426

Timestamp:

04/14/2017 08:46:22 AM (10 years ago)

Author:

swissspidy

Message:

REST API: Allow fetching multiple users at once via the slug parameter.

This matches similar changes previously made for posts (#38579) and terms (#40027).

Props curdin, MatheusGimenez.
Fixes #40213.

Merges [40378] to the 4.7 branch.

Location:

branches/4.7

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/rest-users-controller.php (modified) (1 diff)
• tests/qunit/fixtures/wp-api-generated.js (modified) (1 diff)

branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

@@ -221 +221 @@
                         'search'   => 'search',
                         'roles'    => 'role__in',
+                        'slug'     => 'nicename__in',
                 );
 
@@ -261 +262 @@
                         $prepared_args['search'] = '*' . $prepared_args['search'] . '*';
                 }
-
-                if ( isset( $registered['slug'] ) && ! empty( $request['slug'] ) ) {
-                        $prepared_args['search'] = $request['slug'];
-                        $prepared_args['search_columns'] = array( 'user_nicename' );
-                }
-
                 /**
                  * Filters WP_User_Query arguments when querying users via the REST API.
@@ -1362 +1357 @@
                 $query_params['slug']    = array(
                         'description'        => __( 'Limit result set to users with a specific slug.' ),
-                        'type'               => 'string',
+                        'type'               => 'array',
+                        'items'              => array(
+                                'type'               => 'string',
+                        ),
                 );
 

branches/4.7/tests/phpunit/tests/rest-api/rest-users-controller.php

@@ -583 +583 @@
                 $this->assertEquals( 1, count( $data ) );
                 $this->assertEquals( $id2, $data[0]['id'] );
+        }
+
+        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 );
         }
 

branches/4.7/tests/qunit/fixtures/wp-api-generated.js

@@ -2440 +2440 @@
                             "required": false,
                             "description": "Limit result set to users with a specific slug.",
-                            "type": "string"
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
                         },
                         "roles": {