Skip to content
This repository was archived by the owner on Sep 24, 2018. It is now read-only.

Add include parameter to GET /wp/v2/users #1964

Merged
joehoyle merged 2 commits into from
Jan 8, 2016
Merged

Add include parameter to GET /wp/v2/users #1964

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0df1e99
Add `include` parameter to `GET /wp/v2/users`
danielbachhuber Jan 7, 2016
cf976a0
Fix PHPCS issue
danielbachhuber Jan 7, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion lib/endpoints/class-wp-rest-users-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,13 @@ public function register_routes() {
public function get_items( $request ) {

$prepared_args = array();
$prepared_args['include'] = $request['include'];
$prepared_args['order'] = $request['order'];
$prepared_args['number'] = $request['per_page'];
$prepared_args['offset'] = ( $request['page'] - 1 ) * $prepared_args['number'];
$orderby_possibles = array(
'id' => 'ID',
'include' => 'include',
'name' => 'display_name',
'registered_date' => 'registered',
);
Expand Down Expand Up @@ -781,6 +783,12 @@ public function get_collection_params() {

$query_params['context']['default'] = 'view';

$query_params['include'] = array(
'description' => __( 'Limit result set to specific ids.' ),
'type' => 'array',
'default' => array(),
'sanitize_callback' => 'wp_parse_id_list',
);
$query_params['order'] = array(
'default' => 'asc',
'description' => __( 'Order sort attribute ascending or descending.' ),
Expand All @@ -791,7 +799,12 @@ public function get_collection_params() {
$query_params['orderby'] = array(
'default' => 'name',
'description' => __( 'Sort collection by object attribute.' ),
'enum' => array( 'id', 'name', 'registered_date' ),
'enum' => array(
'id',
'include',
'name',
'registered_date',
),
'sanitize_callback' => 'sanitize_key',
'type' => 'string',
);
Expand Down
20 changes: 20 additions & 0 deletions tests/test-rest-users-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,26 @@ public function test_get_items_orderby() {
$this->assertEquals( $low_id, $data[0]['id'] );
}

public function test_get_items_include_query() {
wp_set_current_user( $this->user );
$id1 = $this->factory->user->create();
$id2 = $this->factory->user->create();
$id3 = $this->factory->user->create();
$request = new WP_REST_Request( 'GET', '/wp/v2/users' );
// Orderby=>asc
$request->set_param( 'include', array( $id3, $id1 ) );
$response = $this->server->dispatch( $request );
$data = $response->get_data();
$this->assertEquals( 2, count( $data ) );
$this->assertEquals( $id1, $data[0]['id'] );
// Orderby=>include
$request->set_param( 'orderby', 'include' );
$response = $this->server->dispatch( $request );
$data = $response->get_data();
$this->assertEquals( 2, count( $data ) );
$this->assertEquals( $id3, $data[0]['id'] );
}

public function test_get_items_search() {
wp_set_current_user( $this->user );
$request = new WP_REST_Request( 'GET', '/wp/v2/users' );
Expand Down