class.wpcom-json-api-site-user-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 14.3.1

jetpack / json-endpoints / class.wpcom-json-api-site-user-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-site-user-endpoint.php

269 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	new WPCOM_JSON_API_Site_User_Endpoint(
4	array(
5	'description' => 'Get details of a user of a site by ID.',
6	'group' => '__do_not_document', // 'users'
7	'stat' => 'sites:1:user',
8	'method' => 'GET',
9	'path' => '/sites/%s/users/%d',
10	'path_labels' => array(
11	'$site' => '(int\|string) Site ID or domain',
12	'$user_id' => '(int) User ID',
13	),
14	'response_format' => WPCOM_JSON_API_Site_User_Endpoint::$user_format,
15	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/30434183/user/23',
16	'example_request_data' => array(
17	'headers' => array(
18	'authorization' => 'Bearer YOUR_API_TOKEN',
19	),
20	),
21	'example_response' => '{
22	"ID": 18342963,
23	"login": "binarysmash",
24	"email": false,
25	"name": "binarysmash",
26	"URL": "http:\/\/binarysmash.wordpress.com",
27	"avatar_URL": "http:\/\/0.gravatar.com\/avatar\/a178ebb1731d432338e6bb0158720fcc?s=96&d=identicon&r=G",
28	"profile_URL": "http:\/\/gravatar.com\/binarysmash",
29	"roles": [ "administrator" ]
30	}',
31	)
32	);
33
34	new WPCOM_JSON_API_Site_User_Endpoint(
35	array(
36	'description' => 'Get details of a user of a site by login.',
37	'group' => 'users',
38	'stat' => 'sites:1:user',
39	'method' => 'GET',
40	'path' => '/sites/%s/users/login:%s',
41	'path_labels' => array(
42	'$site' => '(int\|string) The site ID or domain.',
43	'$user_id' => '(string) The user\'s login.',
44	),
45	'response_format' => WPCOM_JSON_API_Site_User_Endpoint::$user_format,
46	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/30434183/user/login:binarysmash',
47	'example_request_data' => array(
48	'headers' => array(
49	'authorization' => 'Bearer YOUR_API_TOKEN',
50	),
51	),
52	'example_response' => '{
53	"ID": 18342963,
54	"login": "binarysmash",
55	"email": false,
56	"name": "binarysmash",
57	"URL": "http:\/\/binarysmash.wordpress.com",
58	"avatar_URL": "http:\/\/0.gravatar.com\/avatar\/a178ebb1731d432338e6bb0158720fcc?s=96&d=identicon&r=G",
59	"profile_URL": "http:\/\/gravatar.com\/binarysmash",
60	"roles": [ "administrator" ]
61	}',
62	)
63	);
64
65	new WPCOM_JSON_API_Site_User_Endpoint(
66	array(
67	'description' => 'Update details of a user of a site.',
68	'group' => 'users',
69	'stat' => 'sites:1:user',
70	'method' => 'POST',
71	'path' => '/sites/%s/users/%d',
72	'path_labels' => array(
73	'$site' => '(int\|string) The site ID or domain.',
74	'$user_id' => '(int) The user\'s ID.',
75	),
76	'request_format' => WPCOM_JSON_API_Site_User_Endpoint::$user_format,
77	'response_format' => WPCOM_JSON_API_Site_User_Endpoint::$user_format,
78	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/30434183/user/23',
79	'example_request_data' => array(
80	'headers' => array(
81	'authorization' => 'Bearer YOUR_API_TOKEN',
82	),
83	'body' => array(
84	'roles' => array(
85	array(
86	'administrator',
87	),
88	),
89	'first_name' => 'Rocco',
90	'last_name' => 'Tripaldi',
91	),
92	),
93	'example_response' => '{
94	"ID": 18342963,
95	"login": "binarysmash",
96	"email": false,
97	"name": "binarysmash",
98	"URL": "http:\/\/binarysmash.wordpress.com",
99	"avatar_URL": "http:\/\/0.gravatar.com\/avatar\/a178ebb1731d432338e6bb0158720fcc?s=96&d=identicon&r=G",
100	"profile_URL": "http:\/\/gravatar.com\/binarysmash",
101	"roles": [ "administrator" ]
102	}',
103	)
104	);
105
106	/**
107	* Site user endpoint class.
108	*
109	* /sites/%s/users/%d -> $blog_id, $user_id
110	*/
111	class WPCOM_JSON_API_Site_User_Endpoint extends WPCOM_JSON_API_Endpoint {
112
113	/**
114	* User format.
115	*
116	* @var array
117	*/
118	public static $user_format = array(
119	'ID' => '(int) The ID of the user',
120	'login' => '(string) The login username of the user',
121	'email' => '(string) The email of the user',
122	'name' => '(string) The name to display for the user',
123	'first_name' => '(string) The first name of the user',
124	'last_name' => '(string) The last name of the user',
125	'nice_name' => '(string) The nice_name to display for the user',
126	'URL' => '(string) The primary blog of the user',
127	'avatar_URL' => '(url) Gravatar image URL',
128	'profile_URL' => '(url) Gravatar Profile URL',
129	'site_ID' => '(int) ID of the user\'s primary blog',
130	'roles' => '(array\|string) The role or roles of the user',
131	);
132
133	/**
134	* API Callback.
135	*
136	* @param string $path - the path.
137	* @param int $blog_id - the blog ID.
138	* @param int $user_id - the user ID.
139	*
140	* @return array\|WP_Error
141	*/
142	public function callback( $path = '', $blog_id = 0, $user_id = 0 ) {
143	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
144	if ( is_wp_error( $blog_id ) ) {
145	return $blog_id;
146	}
147	// @phan-suppress-next-line PhanDeprecatedFunction -- @todo Switch to current_user_can_for_site when we drop support for WP 6.6.
148	if ( ! current_user_can_for_blog( $blog_id, 'list_users' ) ) {
149	return new WP_Error( 'unauthorized', 'User cannot view users for specified site', 403 );
150	}
151
152	// Get the user by ID or login
153	$get_by = str_contains( $path, '/users/login:' ) ? 'login' : 'id';
154	$user = get_user_by( $get_by, $user_id );
155
156	if ( ! $user ) {
157	return new WP_Error( 'unknown_user', 'Unknown user', 404 );
158	}
159
160	if ( ! is_user_member_of_blog( $user->ID, $blog_id ) ) {
161	return new WP_Error( 'unknown_user_for_site', 'Unknown user for site', 404 );
162	}
163
164	if ( 'GET' === $this->api->method ) {
165	return $this->get_user( $user->ID );
166	} elseif ( 'POST' === $this->api->method ) {
167	// @phan-suppress-next-line PhanDeprecatedFunction -- @todo Switch to current_user_can_for_site when we drop support for WP 6.6.
168	if ( ! current_user_can_for_blog( $blog_id, 'promote_users' ) ) {
169	return new WP_Error( 'unauthorized_no_promote_cap', 'User cannot promote users for specified site', 403 );
170	}
171	return $this->update_user( $user_id, $blog_id );
172	} else {
173	return new WP_Error( 'bad_request', 'An unsupported request method was used.' );
174	}
175	}
176
177	/**
178	* Get the user.
179	*
180	* @param int $user_id - the user ID.
181	*
182	* @return object
183	*/
184	public function get_user( $user_id ) {
185	$the_user = $this->get_author( $user_id, true );
186	if ( $the_user && ! is_wp_error( $the_user ) ) {
187	$userdata = get_userdata( $user_id );
188	$the_user->roles = ! is_wp_error( $userdata ) ? array_values( $userdata->roles ) : array();
189	if ( is_multisite() ) {
190	$the_user->is_super_admin = user_can( $the_user->ID, 'manage_network' );
191	}
192	}
193
194	return $the_user;
195	}
196
197	/**
198	* Updates user data.
199	*
200	* @param int $user_id - the user ID.
201	* @param int $blog_id - the blog ID.
202	*
203	* @return array\|WP_Error
204	*/
205	public function update_user( $user_id, $blog_id ) {
206	$user = array();
207	$input = $this->input();
208	$user['ID'] = $user_id;
209	$is_wpcom = defined( 'IS_WPCOM' ) && IS_WPCOM;
210
211	if ( get_current_user_id() === (int) $user_id && isset( $input['roles'] ) ) {
212	return new WP_Error( 'unauthorized', 'You cannot change your own role', 403 );
213	}
214
215	if ( $is_wpcom && $user_id !== get_current_user_id() && (int) $user_id === wpcom_get_blog_owner( $blog_id ) ) {
216	return new WP_Error( 'unauthorized_edit_owner', 'Current user can not edit blog owner', 403 );
217	}
218
219	if ( ! $is_wpcom ) {
220	foreach ( $input as $key => $value ) {
221	if ( ! is_array( $value ) ) {
222	$value = trim( $value );
223	}
224	$value = wp_unslash( $value );
225	switch ( $key ) {
226	case 'first_name':
227	case 'last_name':
228	$user[ $key ] = $value;
229	break;
230	case 'display_name':
231	case 'name':
232	$user['display_name'] = $value;
233	break;
234	}
235	}
236	}
237
238	if ( isset( $input['roles'] ) ) {
239	// For now, we only use the first role in the array.
240	if ( is_array( $input['roles'] ) ) {
241	$user['role'] = $input['roles'][0];
242	} elseif ( is_string( $input['roles'] ) ) {
243	$user['role'] = $input['roles'];
244	} else {
245	return new WP_Error( 'invalid_input', __( 'The roles property must be a string or an array.', 'jetpack' ), 400 );
246	}
247
248	$editable_roles = array_keys( get_editable_roles() );
249	if ( ! in_array( $user['role'], $editable_roles, true ) ) {
250	return new WP_Error(
251	'invalid_input',
252	sprintf(
253	/* Translators: placeholder is an invalid role name */
254	esc_html__( '%s is not a valid role.', 'jetpack' ),
255	$editable_roles
256	),
257	400
258	);
259	}
260	}
261
262	$result = wp_update_user( $user );
263	if ( is_wp_error( $result ) ) {
264	return $result;
265	}
266	return $this->get_user( $user_id );
267	}
268	}
269