class.wpcom-json-api-list-users-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 14.7.1

jetpack / json-endpoints / class.wpcom-json-api-list-users-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-list-users-endpoint.php

269 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	/**
4	* List users endpoint.
5	*/
6	new WPCOM_JSON_API_List_Users_Endpoint(
7	array(
8	'description' => 'List the users of a site.',
9	'group' => 'users',
10	'stat' => 'users:list',
11
12	'method' => 'GET',
13	'path' => '/sites/%s/users',
14	'path_labels' => array(
15	'$site' => '(int\|string) Site ID or domain',
16	),
17	'rest_route' => '/users',
18	'rest_min_jp_version' => '14.5-a.2',
19
20	'query_parameters' => array(
21	'number' => '(int=20) Limit the total number of authors returned.',
22	'offset' => '(int=0) The first n authors to be skipped in the returned array.',
23	'order' => array(
24	'DESC' => 'Return authors in descending order.',
25	'ASC' => 'Return authors in ascending order.',
26	),
27	'order_by' => array(
28	'ID' => 'Order by ID (default).',
29	'login' => 'Order by username.',
30	'nicename' => 'Order by nicename.',
31	'email' => 'Order by author email address.',
32	'url' => 'Order by author URL.',
33	'registered' => 'Order by registered date.',
34	'display_name' => 'Order by display name.',
35	'post_count' => 'Order by number of posts published.',
36	),
37	'authors_only' => '(bool) Set to true to fetch authors only',
38	'include_viewers' => '(bool) Set to true to include viewers for Simple sites. When you pass in this parameter, order, order_by and search_columns are ignored. Currently, `search` is limited to the first page of results.',
39	'type' => "(string) Specify the post type to query authors for. Only works when combined with the `authors_only` flag. Defaults to 'post'. Post types besides post and page need to be whitelisted using the <code>rest_api_allowed_post_types</code> filter.",
40	'search' => '(string) Find matching users.',
41	'search_columns' => "(array) Specify which columns to check for matching users. Can be any of 'ID', 'user_login', 'user_email', 'user_url', 'user_nicename', and 'display_name'. Only works when combined with `search` parameter.",
42	'role' => '(string) Specify a specific user role to fetch.',
43	'capability' => '(string) Specify a specific capability to fetch. You can specify multiple by comma separating them, in which case the user needs to match all capabilities provided.',
44	),
45
46	'response_format' => array(
47	'found' => '(int) The total number of authors found that match the request (ignoring limits and offsets).',
48	'authors' => '(array:author) Array of author objects.',
49	),
50
51	'example_response' => '{
52	"found": 1,
53	"users": [
54	{
55	"ID": 78972699,
56	"login": "apiexamples",
57	"email": "justin+apiexamples@a8c.com",
58	"name": "apiexamples",
59	"first_name": "",
60	"last_name": "",
61	"nice_name": "apiexamples",
62	"URL": "http://apiexamples.wordpress.com",
63	"avatar_URL": "https://1.gravatar.com/avatar/a2afb7b6c0e23e5d363d8612fb1bd5ad?s=96&d=identicon&r=G",
64	"profile_URL": "https://gravatar.com/apiexamples",
65	"site_ID": 82974409,
66	"roles": [
67	"administrator"
68	],
69	"is_super_admin": false
70	}
71	]
72	}',
73
74	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/users',
75	'example_request_data' => array(
76	'headers' => array(
77	'authorization' => 'Bearer YOUR_API_TOKEN',
78	),
79	),
80	)
81	);
82
83	/**
84	* List users endpoint class.
85	*
86	* /sites/%s/users/ -> $blog_id
87	*/
88	class WPCOM_JSON_API_List_Users_Endpoint extends WPCOM_JSON_API_Endpoint {
89
90	/**
91	* The response format.
92	*
93	* @var array
94	*/
95	public $response_format = array(
96	'found' => '(int) The total number of authors found that match the request (ignoring limits and offsets).',
97	'users' => '(array:author) Array of user objects',
98	);
99
100	/**
101	* Columns in which to search for a user match.
102	*
103	* @var array
104	*/
105	public $search_columns;
106
107	/**
108	* API callback.
109	*
110	* @param string $path - the path.
111	* @param string $blog_id - the blog ID.
112	*/
113	public function callback( $path = '', $blog_id = 0 ) {
114	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
115	if ( is_wp_error( $blog_id ) ) {
116	return $blog_id;
117	}
118
119	$args = $this->query_args();
120
121	$authors_only = ( ! empty( $args['authors_only'] ) );
122
123	if ( $args['number'] < 1 ) {
124	$args['number'] = 20;
125	} elseif ( 1000 < $args['number'] ) {
126	return new WP_Error( 'invalid_number', 'The NUMBER parameter must be less than or equal to 1000.', 400 );
127	}
128
129	if ( $authors_only ) {
130	if ( empty( $args['type'] ) ) {
131	$args['type'] = 'post';
132	}
133
134	if ( ! $this->is_post_type_allowed( $args['type'] ) ) {
135	return new WP_Error( 'unknown_post_type', 'Unknown post type', 404 );
136	}
137
138	$post_type_object = get_post_type_object( $args['type'] );
139	if ( ! $post_type_object \|\| ! current_user_can( $post_type_object->cap->edit_others_posts ) ) {
140	return new WP_Error( 'unauthorized', 'User cannot view authors for specified post type', 403 );
141	}
142	} elseif ( ! current_user_can( 'list_users' ) ) {
143	return new WP_Error( 'unauthorized', 'User cannot view users for specified site', 403 );
144	}
145
146	$query = array(
147	'number' => $args['number'],
148	'offset' => $args['offset'],
149	'order' => $args['order'],
150	'orderby' => $args['order_by'],
151	'fields' => 'ID',
152	);
153
154	if ( $authors_only ) {
155	$query['capability'] = array( 'edit_posts' );
156	}
157
158	if ( ! empty( $args['search'] ) ) {
159	$query['search'] = $args['search'];
160	}
161
162	if ( ! empty( $args['search_columns'] ) ) {
163	// this `user_search_columns` filter is necessary because WP_User_Query does not allow `display_name` as a search column.
164	$this->search_columns = array_intersect( $args['search_columns'], array( 'ID', 'user_login', 'user_email', 'user_url', 'user_nicename', 'display_name' ) );
165	add_filter( 'user_search_columns', array( $this, 'api_user_override_search_columns' ), 10, 3 );
166	}
167
168	if ( ! empty( $args['role'] ) ) {
169	$query['role'] = $args['role'];
170	}
171
172	if ( ! empty( $args['capability'] ) ) {
173	$query['capability'] = $args['capability'];
174	}
175
176	$user_query = new WP_User_Query( $query );
177
178	remove_filter( 'user_search_columns', array( $this, 'api_user_override_search_columns' ) );
179
180	$is_wpcom = defined( 'IS_WPCOM' ) && IS_WPCOM;
181	$include_viewers = (bool) isset( $args['include_viewers'] ) && $args['include_viewers'] && $is_wpcom;
182
183	$page = ( (int) ( $args['offset'] / $args['number'] ) ) + 1;
184	$viewers = $include_viewers ? get_private_blog_users(
185	$blog_id,
186	array(
187	'page' => $page,
188	'per_page' => $args['number'],
189	)
190	) : array();
191	$viewers = array_map( array( $this, 'get_author' ), $viewers );
192
193	// When include_viewers is true, search by username or email.
194	if ( $include_viewers && ! empty( $args['search'] ) ) {
195	$viewers = array_filter(
196	$viewers,
197	function ( $viewer ) use ( $args ) {
198	// Convert to WP_User so expected fields are available.
199	$wp_viewer = new WP_User( $viewer->ID );
200	// remove special database search characters from search term
201	$search_term = str_replace( '*', '', $args['search'] );
202	return ( str_contains( $wp_viewer->user_login, $search_term ) \|\| str_contains( $wp_viewer->user_email, $search_term ) \|\| str_contains( $wp_viewer->display_name, $search_term ) );
203	}
204	);
205	}
206
207	$return = array();
208	foreach ( array_keys( $this->response_format ) as $key ) {
209	switch ( $key ) {
210	case 'found':
211	$user_count = (int) $user_query->get_total();
212
213	$viewer_count = 0;
214	if ( $include_viewers ) {
215	if ( empty( $args['search'] ) ) {
216	$viewer_count = (int) get_count_private_blog_users( $blog_id );
217	} else {
218	$viewer_count = count( $viewers );
219	}
220	}
221
222	$return[ $key ] = $user_count + $viewer_count;
223	break;
224	case 'users':
225	$users = array();
226	$is_multisite = is_multisite();
227	foreach ( $user_query->get_results() as $u ) {
228	$the_user = $this->get_author( $u, true );
229	if ( $the_user && ! is_wp_error( $the_user ) ) {
230	$userdata = get_userdata( $u );
231	$the_user->roles = ! is_wp_error( $userdata ) ? array_values( $userdata->roles ) : array();
232	if ( $is_multisite ) {
233	$the_user->is_super_admin = user_can( $the_user->ID, 'manage_network' );
234	}
235	$users[] = $the_user;
236	}
237	}
238
239	$combined_users = array_merge( $users, $viewers );
240
241	// When viewers are included, we ignore the order & orderby parameters.
242	if ( $include_viewers ) {
243	usort(
244	$combined_users,
245	function ( $a, $b ) {
246	return strcmp( strtolower( $a->name ), strtolower( $b->name ) );
247	}
248	);
249	}
250
251	$return[ $key ] = $combined_users;
252	break;
253	}
254	}
255
256	return $return;
257	}
258
259	/**
260	* Override search columns.
261	*
262	* @param array $search_columns - the search column we're overriding.
263	* @param array $search - the search query.
264	*/
265	public function api_user_override_search_columns( $search_columns, $search ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
266	return $this->search_columns;
267	}
268	}
269