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

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

jetpack / json-endpoints Last commit date

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

173 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	/**
4	* List roles endpoint.
5	*/
6	new WPCOM_JSON_API_List_Roles_Endpoint(
7	array(
8	'description' => 'List the user roles of a site.',
9	'group' => '__do_not_document',
10	'stat' => 'roles:list',
11	'max_version' => '1.1',
12	'method' => 'GET',
13	'path' => '/sites/%s/roles',
14	'path_labels' => array(
15	'$site' => '(int\|string) Site ID or domain',
16	),
17
18	'query_parameters' => array(),
19
20	'response_format' => array(
21	'roles' => '(array:role) Array of role objects.',
22	),
23
24	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/roles',
25	'example_request_data' => array(
26	'headers' => array(
27	'authorization' => 'Bearer YOUR_API_TOKEN',
28	),
29	),
30	)
31	);
32
33	new WPCOM_JSON_API_List_Roles_Endpoint(
34	array(
35	'description' => 'List the user roles of a site.',
36	'group' => '__do_not_document',
37	'stat' => 'roles:list',
38	'min_version' => '1.2',
39	'force' => 'wpcom',
40	'method' => 'GET',
41	'path' => '/sites/%s/roles',
42	'path_labels' => array(
43	'$site' => '(int\|string) Site ID or domain',
44	),
45
46	'query_parameters' => array(),
47
48	'response_format' => array(
49	'roles' => '(array:role) Array of role objects.',
50	),
51
52	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/roles',
53	'example_request_data' => array(
54	'headers' => array(
55	'authorization' => 'Bearer YOUR_API_TOKEN',
56	),
57	),
58	)
59	);
60
61	/**
62	* List Roles endpoint class.
63	*
64	* /sites/%s/roles/ -> $blog_id
65	*/
66	class WPCOM_JSON_API_List_Roles_Endpoint extends WPCOM_JSON_API_Endpoint {
67
68	/**
69	* Response format.
70	*
71	* @var array
72	*/
73	public $response_format = array(
74	'roles' => '(array:role) Array of role objects',
75	);
76
77	/**
78	* Sort so roles with the most number of capabilities comes first, then the next role, and so on.
79	*
80	* @param object $a - the first object we're comparing.
81	* @param object $b - the second object we're comparing.
82	*/
83	public static function role_sort( $a, $b ) {
84	$core_role_names = array( 'administrator', 'editor', 'author', 'contributor', 'subscriber' );
85	$a_is_core_role = in_array( $a->name, $core_role_names, true );
86	$b_is_core_role = in_array( $b->name, $core_role_names, true );
87
88	// if $a is a core_role and $b is not, $a always comes first.
89	if ( $a_is_core_role && ! $b_is_core_role ) {
90	return -1;
91	}
92
93	// if $b is a core_role and $a is not, $b always comes first.
94	if ( $b_is_core_role && ! $a_is_core_role ) {
95	return 1;
96	}
97
98	// otherwise the one with the > number of capabilities comes first.
99	$a_cap_count = is_countable( $a->capabilities ) ? count( $a->capabilities ) : 0;
100	$b_cap_count = is_countable( $b->capabilities ) ? count( $b->capabilities ) : 0;
101
102	if ( $a_cap_count === $b_cap_count ) {
103	return 0;
104	}
105
106	return ( $a_cap_count > $b_cap_count ) ? -1 : 1;
107	}
108
109	/**
110	* API callback.
111	*
112	* @param string $path - the path.
113	* @param string $blog_id - the blog ID.
114	*/
115	public function callback( $path = '', $blog_id = 0 ) {
116	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
117	if ( is_wp_error( $blog_id ) ) {
118	return $blog_id;
119	}
120
121	$roles = array();
122
123	$sal_site = $this->get_platform()->get_site( $blog_id );
124	$wp_roles = $sal_site->get_roles();
125
126	// Check if the site is connected and talks to us on a regular basis.
127	$is_connected = $sal_site->is_connected_site();
128	if ( is_wp_error( $is_connected ) ) {
129	return $is_connected;
130	}
131
132	if ( ! $sal_site->current_user_can( 'list_users' ) ) {
133	return new WP_Error( 'unauthorized', 'User cannot view roles for specified site', 403 );
134	}
135
136	if ( method_exists( $wp_roles, 'get_names' ) ) {
137	$role_names = $wp_roles->get_names();
138
139	$role_keys = array_keys( $role_names );
140
141	foreach ( (array) $role_keys as $role_key ) {
142	$role_details = get_role( $role_key );
143	$role_details->display_name = translate_user_role( $role_names[ $role_key ] );
144	$roles[] = $role_details;
145	}
146	} else {
147	// Jetpack Shadow Site side of things.
148	foreach ( $wp_roles as $role_key => $role ) {
149	$roles[] = (object) array(
150	'name' => $role_key,
151	'display_name' => $role['name'],
152	'capabilities' => (object) $role['capabilities'],
153	);
154	}
155	}
156
157	usort( $roles, array( 'self', 'role_sort' ) );
158
159	/**
160	* Filter for curating the list of roles available for a wpcom site.
161	*
162	* @module json-api
163	*
164	* @since 8.7.0
165	*
166	* @param array $roles List of role objects available to the site.
167	*/
168	$roles = apply_filters( 'wpcom_api_site_roles', $roles );
169
170	return array( 'roles' => $roles );
171	}
172	}
173