Repository navigation
Expand file tree
/
Copy pathabilities.php
More file actions
381 lines (357 loc) · 12.6 KB
/
Copy pathabilities.php
File metadata and controls
381 lines (357 loc) · 12.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
<?php
/**
* Core Abilities registration.
*
* @package WordPress
* @subpackage Abilities_API
* @since 6.9.0
*/
declare( strict_types = 1 );
require_once __DIR__ . '/abilities/class-wp-abilities-content.php';
require_once __DIR__ . '/abilities/class-wp-abilities-settings.php';
require_once __DIR__ . '/abilities/class-wp-abilities-users.php';
/**
* Registers the core ability categories.
*
* @since 6.9.0
* @since 7.2.0 Added the `content` and `uncategorized` categories.
*/
function wp_register_core_ability_categories(): void {
wp_register_ability_category(
'site',
array(
'label' => __( 'Site' ),
'description' => __( 'Abilities that retrieve or modify site information and settings.' ),
)
);
wp_register_ability_category(
'user',
array(
'label' => __( 'User' ),
'description' => __( 'Abilities that retrieve or modify user information and settings.' ),
)
);
wp_register_ability_category(
'content',
array(
'label' => __( 'Content' ),
'description' => __( 'Abilities that retrieve or manage posts and other content.' ),
)
);
wp_register_ability_category(
'uncategorized',
array(
'label' => __( 'Uncategorized' ),
'description' => __( 'Abilities that have not been assigned to a specific category.' ),
)
);
}
/**
* Registers the default core abilities.
*
* @since 6.9.0
* @since 7.2.0 Added the `core/content-query`, `core/settings-get`, and `core/users-query` abilities.
*
* @global wpdb $wpdb WordPress database abstraction object.
*/
function wp_register_core_abilities(): void {
$category_site = 'site';
$category_user = 'user';
$site_info_properties = array(
'name' => array(
'type' => 'string',
'title' => __( 'Site Title' ),
'description' => __( 'The site title.' ),
),
'description' => array(
'type' => 'string',
'title' => __( 'Tagline' ),
'description' => __( 'The site tagline.' ),
),
'url' => array(
'type' => 'string',
'title' => __( 'Site Address (URL)' ),
'description' => __( 'The public URL where visitors access the site. May differ from the WordPress installation URL.' ),
),
'wpurl' => array(
'type' => 'string',
'title' => __( 'WordPress Address (URL)' ),
'description' => __( 'The URL where WordPress core files are served. May differ from the public site URL.' ),
),
'admin_email' => array(
'type' => 'string',
'title' => __( 'Administration Email Address' ),
'description' => __( 'The site administrator email address.' ),
),
'charset' => array(
'type' => 'string',
'title' => __( 'Site Charset' ),
'description' => __( 'The site character encoding.' ),
),
'language' => array(
'type' => 'string',
'title' => __( 'Site Language' ),
'description' => __( 'The site locale in dash form (e.g. en-US).' ),
),
'version' => array(
'type' => 'string',
'title' => __( 'WordPress Version' ),
'description' => __( 'The WordPress core version running on this site.' ),
),
);
$site_info_fields = array_keys( $site_info_properties );
wp_register_ability(
'core/get-site-info',
array(
'label' => __( 'Get Site Information' ),
'description' => __( 'Returns site information configured in WordPress. By default returns all fields, or optionally a filtered subset.' ),
'category' => $category_site,
'input_schema' => array(
'type' => 'object',
'properties' => array(
'fields' => array(
'type' => 'array',
'items' => array(
'type' => 'string',
'enum' => $site_info_fields,
),
'description' => __( 'Optional: Limit response to specific fields. If omitted, all fields are returned.' ),
),
),
'additionalProperties' => false,
'default' => array(),
),
'output_schema' => array(
'type' => 'object',
'properties' => $site_info_properties,
'additionalProperties' => false,
),
'execute_callback' => static function ( $input = array() ) use ( $site_info_fields ): array {
$input = is_array( $input ) ? $input : array();
$requested_fields = ! empty( $input['fields'] ) ? $input['fields'] : $site_info_fields;
$result = array();
foreach ( $requested_fields as $field ) {
if ( 'language' === $field ) {
$result[ $field ] = str_replace( '_', '-', get_locale() );
} else {
$result[ $field ] = get_bloginfo( $field );
}
}
return $result;
},
'required_capabilities' => array( 'manage_options' ),
'meta' => array(
'annotations' => array(
'readonly' => true,
'destructive' => false,
'idempotent' => true,
),
'public' => true,
),
)
);
$user_info_properties = array(
'id' => array(
'type' => 'integer',
'title' => __( 'User ID' ),
'description' => __( 'Unique identifier for the user.' ),
),
'display_name' => array(
'type' => 'string',
'title' => __( 'Display Name' ),
'description' => __( 'Public-facing name selected by the user.' ),
),
'user_nicename' => array(
'type' => 'string',
'title' => __( 'User Nicename' ),
'description' => __( 'URL-friendly slug for the user. Defaults to the username.' ),
),
'user_login' => array(
'type' => 'string',
'title' => __( 'Username' ),
'description' => __( 'Login identifier for the user. Cannot be changed once set.' ),
),
'roles' => array(
'type' => 'array',
'title' => __( 'Roles' ),
'description' => __( 'Roles assigned to the user, such as administrator, editor, author, contributor, or subscriber.' ),
'items' => array(
'type' => 'string',
),
),
'locale' => array(
'type' => 'string',
'title' => __( 'Language' ),
'description' => __( 'Locale code for the user, such as en_US.' ),
),
'first_name' => array(
'type' => 'string',
'title' => __( 'First Name' ),
'description' => __( 'Given name.' ),
),
'last_name' => array(
'type' => 'string',
'title' => __( 'Last Name' ),
'description' => __( 'Family name.' ),
),
'nickname' => array(
'type' => 'string',
'title' => __( 'Nickname' ),
'description' => __( 'Informal name. Defaults to the username.' ),
),
'description' => array(
'type' => 'string',
'title' => __( 'Biographical Info' ),
'description' => __( 'User-authored biography. May be empty.' ),
),
'user_url' => array(
'type' => 'string',
'title' => __( 'Website' ),
'description' => __( 'Personal website URL.' ),
),
);
$user_info_fields = array_keys( $user_info_properties );
wp_register_ability(
'core/get-user-info',
array(
'label' => __( 'Get User Information' ),
'description' => __( 'Returns profile details for the current authenticated user to support personalization, auditing, and access-aware behavior. By default returns all fields, or optionally a filtered subset.' ),
'category' => $category_user,
'input_schema' => array(
'type' => 'object',
'properties' => array(
'fields' => array(
'type' => 'array',
'items' => array(
'type' => 'string',
'enum' => $user_info_fields,
),
'description' => __( 'Optional: Limit response to specific fields. If omitted, all fields are returned.' ),
),
),
'additionalProperties' => false,
'default' => array(),
),
'output_schema' => array(
'type' => 'object',
'properties' => $user_info_properties,
'additionalProperties' => false,
),
'execute_callback' => static function ( $input = array() ) use ( $user_info_fields ): array {
$input = is_array( $input ) ? $input : array();
$requested_fields = ! empty( $input['fields'] ) ? $input['fields'] : $user_info_fields;
$current_user = wp_get_current_user();
$all = array(
'id' => $current_user->ID,
'display_name' => $current_user->display_name,
'user_nicename' => $current_user->user_nicename,
'user_login' => $current_user->user_login,
// Ensure roles are encoded as a JSON array, regardless of their array keys.
'roles' => array_values( $current_user->roles ),
'locale' => get_user_locale( $current_user ),
'first_name' => $current_user->first_name,
'last_name' => $current_user->last_name,
'nickname' => $current_user->nickname,
'description' => $current_user->description,
'user_url' => $current_user->user_url,
);
return array_intersect_key( $all, array_flip( $requested_fields ) );
},
'permission_callback' => static function (): bool {
return is_user_logged_in();
},
'meta' => array(
'annotations' => array(
'readonly' => true,
'destructive' => false,
'idempotent' => true,
),
'public' => true,
),
)
);
$environment_info_properties = array(
'environment' => array(
'type' => 'string',
'title' => __( 'Environment Type' ),
'description' => __( 'The site\'s runtime environment classification.' ),
'enum' => array( 'production', 'staging', 'development', 'local' ),
),
'php_version' => array(
'type' => 'string',
'title' => __( 'PHP Version' ),
'description' => __( 'The PHP runtime version executing WordPress.' ),
),
'db_server_info' => array(
'type' => 'string',
'title' => __( 'Database Server Info' ),
'description' => __( 'The database server vendor and version string reported by the driver.' ),
),
'wp_version' => array(
'type' => 'string',
'title' => __( 'WordPress Version' ),
'description' => __( 'The WordPress core version running on this site.' ),
),
);
$environment_info_fields = array_keys( $environment_info_properties );
wp_register_ability(
'core/get-environment-info',
array(
'label' => __( 'Get Environment Info' ),
'description' => __( 'Returns core details about the site\'s runtime context for diagnostics and compatibility (environment, PHP runtime, database server info, WordPress version). By default returns all fields, or optionally a filtered subset.' ),
'category' => $category_site,
'input_schema' => array(
'type' => 'object',
'properties' => array(
'fields' => array(
'type' => 'array',
'items' => array(
'type' => 'string',
'enum' => $environment_info_fields,
),
'description' => __( 'Optional: Limit response to specific fields. If omitted, all fields are returned.' ),
),
),
'additionalProperties' => false,
'default' => array(),
),
'output_schema' => array(
'type' => 'object',
'properties' => $environment_info_properties,
'additionalProperties' => false,
),
'execute_callback' => static function ( $input = array() ) use ( $environment_info_fields ): array {
global $wpdb;
/** @var array{ fields?: string[] } $input */
$input = is_array( $input ) ? $input : array();
$requested_fields = ! empty( $input['fields'] ) ? $input['fields'] : $environment_info_fields;
$db_server_info = '';
if ( method_exists( $wpdb, 'db_server_info' ) ) {
$db_server_info = $wpdb->db_server_info() ?? '';
}
$all = array(
'environment' => wp_get_environment_type(),
'php_version' => phpversion(),
'db_server_info' => $db_server_info,
'wp_version' => get_bloginfo( 'version' ),
);
return array_intersect_key( $all, array_flip( $requested_fields ) );
},
'required_capabilities' => array( 'view_site_health_checks' ),
'meta' => array(
'annotations' => array(
'readonly' => true,
'destructive' => false,
'idempotent' => true,
),
'public' => true,
),
)
);
// Register the settings abilities (currently the read-only `core/settings-get`).
( new WP_Abilities_Settings() )->register();
// Register the user abilities (currently the read-only `core/users-query`).
( new WP_Abilities_Users() )->register();
// Register the content abilities (currently the read-only `core/content-query`).
( new WP_Abilities_Content() )->register();
}