Merge pull request #2000 from WP-API/1970-exclude-users

Add `exclude` param to `GET /wp/v2/users`

lib/endpoints/class-wp-rest-users-controller.php

@@ -80,6 +80,7 @@ public function register_routes() {
 	public function get_items( $request ) {
 
 		$prepared_args = array();
+		$prepared_args['exclude'] = $request['exclude'];
 		$prepared_args['include'] = $request['include'];
 		$prepared_args['order'] = $request['order'];
 		$prepared_args['number'] = $request['per_page'];

tests/test-rest-users-controller.php

@@ -50,6 +50,23 @@ public function test_context_param() {
 		$this->assertEquals( array( 'view', 'embed', 'edit' ), $data['endpoints'][0]['args']['context']['enum'] );
 	}
 
+	public function test_registered_query_params() {
+		$request = new WP_REST_Request( 'OPTIONS', '/wp/v2/users' );
+		$response = $this->server->dispatch( $request );
+		$data = $response->get_data();
+		$keys = array_keys( $data['endpoints'][0]['args'] );
+		sort( $keys );
+		$this->assertEquals( array(
+			'context',
+			'include',
+			'order',
+			'orderby',
+			'page',
+			'per_page',
+			'search',
+			), $keys );
+	}
+
 	public function test_get_items() {
 		wp_set_current_user( $this->user );
 
@@ -226,6 +243,22 @@ public function test_get_items_include_query() {
 		$this->assertEquals( $id3, $data[0]['id'] );
 	}
 
+	public function test_get_items_exclude_query() {
+		wp_set_current_user( $this->user );
+		$id1 = $this->factory->user->create();
+		$id2 = $this->factory->user->create();
+		$request = new WP_REST_Request( 'GET', '/wp/v2/users' );
+		$response = $this->server->dispatch( $request );
+		$data = $response->get_data();
+		$this->assertTrue( in_array( $id1, wp_list_pluck( $data, 'id' ) ) );
+		$this->assertTrue( in_array( $id2, wp_list_pluck( $data, 'id' ) ) );
+		$request->set_param( 'exclude', array( $id2 ) );
+		$response = $this->server->dispatch( $request );
+		$data = $response->get_data();
+		$this->assertTrue( in_array( $id1, wp_list_pluck( $data, 'id' ) ) );
+		$this->assertFalse( in_array( $id2, wp_list_pluck( $data, 'id' ) ) );
+	}
+
 	public function test_get_items_search() {
 		wp_set_current_user( $this->user );
 		$request = new WP_REST_Request( 'GET', '/wp/v2/users' );