class-acf-rest-api.php
16.7 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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
<?php
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
// If class is already defined, return.
if ( class_exists( 'ACF_Rest_Api' ) ) {
return;
}
class ACF_Rest_Api {
/** @var ACF_Rest_Request */
private $request;
/** @var ACF_Rest_Embed_Links */
private $embed_links;
public function __construct() {
add_action( 'rest_api_init', array( $this, 'initialize' ) );
}
public function initialize() {
if ( ! acf_get_setting( 'rest_api_enabled' ) ) {
return;
}
// Parse request and set the object for local access.
$this->request = new ACF_Rest_Request();
$this->request->parse_request();
// Register the 'acf' REST property.
$this->register_field();
// If embed links are enabled in ACF's global settings, init the handler and set for local access.
if ( acf_get_setting( 'rest_api_embed_links' ) ) {
$this->embed_links = new ACF_Rest_Embed_Links();
$this->embed_links->initialize();
}
}
/**
* Register our custom property as a REST field.
*/
private function register_field() {
$base = $this->request->object_sub_type;
// If the object sub type ($post_type, $taxonomy, 'user') cannot be determined from the current request,
// we don't know what endpoint to register the field against. Bail if that is the case.
if ( ! $base ) {
return;
}
if ( $this->request->child_object_type ) {
$base = $this->request->child_object_type;
}
register_rest_field(
$base,
'acf',
array(
'schema' => $this->get_schema(),
'get_callback' => array( $this, 'load_fields' ),
'update_callback' => array( $this, 'update_fields' ),
)
);
}
/**
* Dynamically generate the schema for the current request.
*
* @return array
*/
private function get_schema() {
$schema = array(
'description' => 'ACF field data',
'type' => 'object',
'properties' => array(),
'arg_options' => array(
'validate_callback' => array( $this, 'validate_rest_arg' ),
),
);
// If we don't have an object type, we can't determine the schema for the current request.
$object_type = $this->request->object_type;
if ( ! $object_type ) {
return $schema;
}
$object_id = $this->request->get_url_param( 'id' );
$child_id = $this->request->get_url_param( 'child_id' );
$object_sub_type = $this->request->object_sub_type;
if ( $child_id ) {
$object_id = $child_id;
}
if ( ! $object_id ) {
$field_groups = $this->get_field_groups_by_object_type( $object_type );
} else {
$field_groups = $this->get_field_groups_by_id( $object_id, $object_type, $object_sub_type );
}
if ( empty( $field_groups ) ) {
return $schema;
}
foreach ( $field_groups as $field_group ) {
foreach ( $this->get_fields( $field_group, $object_id ) as $field ) {
$schema['properties'][ $field['name'] ] = acf_get_field_rest_schema( $field );
}
}
return $schema;
}
/**
* Validate the request args. Mostly a wrapper for `rest_validate_request_arg()`, but also
* fires off a filter, so we can add some custom validation for specific fields.
*
* This will likely no longer be needed once WordPress implements something like `validate_callback`
* and `sanitize_callback` for nested schema properties, see:
* https://core.trac.wordpress.org/ticket/49960
*
* @param mixed $value
* @param \WP_REST_Request $request
* @param string $param
*
* @return bool|WP_Error
*/
public function validate_rest_arg( $value, $request, $param ) {
// Validate all fields with default WordPress validation first.
$valid = rest_validate_request_arg( $value, $request, $param );
if ( true !== $valid ) {
return $valid;
}
foreach ( $value as $field_name => $field_value ) {
$field = acf_get_field( $field_name );
if ( ! $field ) {
continue;
}
/**
* Filters whether a value passed via REST is valid.
*
* @since 5.11
*
* @param bool $valid True if the value is valid, false or WP_Error if not.
* @param mixed $value The value to check.
* @param array $field An array of information about the field.
*/
$valid = apply_filters( 'acf/validate_rest_value/type=' . $field['type'], true, $field_value, $field );
if ( true !== $valid ) {
return $valid;
}
}
return true;
}
/**
* Load field values into the requested object. This method is not a part of any public API and is only public as
* it is required by WordPress.
*
* @param array $object An array representation of the post, term, or user object.
* @param string $field_name
* @param WP_REST_Request $request
* @param string $object_sub_type Note that this isn't the same as $this->object_type. This variable is
* more specific and can be a post type or taxonomy.
* @return array
*/
public function load_fields( $object, $field_name, $request, $object_sub_type ) {
// The fields loaded for display on the REST API in the form of {$field_name}=>{$field_value} pairs.
$fields = array();
// Determine the object ID from the given object.
$object_id = acf_get_object_id( $object );
// Use this object type parsed from the request.
$object_type = $this->request->object_type;
// Object ID and type are essential to determining which fields to load. Return if we don't have both.
if ( ! $object_id or ! $object_type ) {
return $fields;
}
$object_sub_type = str_replace( '-revision', '', $object_sub_type );
// Get all field groups for the current object.
$field_groups = $this->get_field_groups_by_id( $object_id, $object_type, $object_sub_type );
if ( empty( $field_groups ) ) {
return $fields;
}
// Determine the ACF ID string for the current object.
$post_id = $this->make_identifier( $object_id, $object_type );
// Loop through the fields within all applicable field groups and add the fields to the response.
foreach ( $field_groups as $field_group ) {
foreach ( $this->get_fields( $field_group, $object_id ) as $field ) {
$value = acf_get_value( $post_id, $field );
if ( $this->embed_links ) {
$this->embed_links->prepare_links( $post_id, $field );
}
// Format the field value according to the request params.
$format = $request->get_param( 'acf_format' ) ?: acf_get_setting( 'rest_api_format' );
$value = acf_format_value_for_rest( $value, $post_id, $field, $format );
$fields[ $field['name'] ] = $value;
}
}
return $fields;
}
/**
* Update any incoming field values for the given object. This method is not a part of any public API and is only
* public as it is required by WordPress.
*
* @param array $data
* @param WP_Post|WP_Term|WP_User $object
* @param string $property 'acf'
* @param WP_REST_Request $request
* @param string $object_sub_type This will be the post type, the taxonomy, or 'user'.
* @return bool|WP_Error
*/
public function update_fields( $data, $object, $property, $request, $object_sub_type ) {
// If 'acf' data object is empty, don't do anything.
if ( empty( $data ) ) {
return true;
}
// Determine the object context (type & ID). If the context can't be determined from the current request, throw an
// error as the fields are not updateable. This handles in line with WordPress' \WP_REST_Request::sanitize_params().
$object_id = acf_get_object_id( $object );
$object_type = $this->request->object_type;
if ( ! $object_id or ! $object_type ) {
return new WP_Error(
'acf_rest_object_unknown',
__( sprintf( 'Unable to determine the %s object ID or type. The %s property cannot be updated.', get_class( $object ), $property ), 'acf' ),
array( 'status' => 400 )
);
}
// Determine the ACF selector for the current object.
$post_id = $this->make_identifier( $object_id, $object_type );
// Allow unrestricted update of fields by field key when saving via the WordPress admin. Admin mode will
// update fields using their field keys to lookup the field. The field lookup is not scoped to field groups
// located on the given object so any field can be updated. Given the field keys are not defined in the
// schema, core validation/sanitisation are also bypassed.
// if ( $this->is_admin_mode( $data ) ) {
// Loop through payload and save fields using field keys.
// foreach ( $data as $field_key => $value ) {
// if ( $field = acf_get_field( $field_key ) ) {
// acf_update_value( $value, $post_id, $field );
// }
// }
//
// return true;
// }
// todo - consider/discuss handling this in the request object instead
// If the incoming data defines field group keys, extract it from the data. This is used to scope the
// field lookup in \ACF_Rest_Api::get_field_groups_by_id();
$field_group_scope = acf_extract_var( $data, '_acf_field_group_scope', array() );
// Get all field groups for the current object.
$field_groups = $this->get_field_groups_by_id( $object_id, $object_type, $object_sub_type, $field_group_scope );
if ( empty( $field_groups ) ) {
return true;
}
// Collect all fields from matching field groups.
$all_fields = array();
foreach ( $field_groups as $field_group ) {
if ( $fields = $this->get_fields( $field_group, $object_id ) ) {
$all_fields = array_merge( $fields, $all_fields );
}
}
if ( $all_fields ) {
// todo - consider/discuss handling this in the request object instead.
// If the incoming request has a map of field names to keys, extract it for use in the subsequent
// field search.
$field_key_map = acf_extract_var( $data, '_acf_field_key_map', array() );
// Loop through the inbound data payload, find the field matching the incoming field name, and
// update the field.
foreach ( $data as $field_name => $value ) {
// If the field name has a key explicitly mapped to it, use the field key to find the field.
if ( isset( $field_key_map[ $field_name ] ) ) {
$field_name = $field_key_map[ $field_name ];
}
if ( $field = acf_search_fields( $field_name, $all_fields ) ) {
acf_update_value( $value, $post_id, $field );
}
}
}
return true;
}
// todo - this should check for a flag and validate a nonce to ensure we are in admin mode.
// todo - consider/discuss handling this in the request object instead.
private function is_admin_mode( $data ) {
return isset( $data['_acf_admin_mode'] ) && $data['_acf_admin_mode'];
}
/**
* Make the ACF identifier string for the given object.
*
* @param int $object_id
* @param string $object_type 'user', 'term', or 'post'
* @return string
*/
private function make_identifier( $object_id, $object_type ) {
$formats = array(
'user' => 'user_%s',
'term' => 'term_%s',
);
return isset( $formats[ $object_type ] )
? sprintf( $formats[ $object_type ], $object_id )
: $object_id;
}
/**
* Gets an array of the location types that a field group is configured to use.
*
* @param string $object_type 'user', 'term', or 'post'
* @param array $field_group The field group to check.
* @param array $location_types An array of location types.
*
* @return bool
*/
private function object_type_has_field_group( $object_type, $field_group, $location_types = array() ) {
if ( ! isset( $field_group['location'] ) || ! is_array( $field_group['location'] ) ) {
return false;
}
$location_types = empty( $location_types ) ? acf_get_location_types() : $location_types;
foreach ( $field_group['location'] as $rule_group ) {
$match = false;
foreach ( $rule_group as $rule ) {
$rule = acf_validate_location_rule( $rule );
if ( ! isset( $location_types[ $rule['param'] ] ) ) {
continue;
}
// Make sure the main object type matches.
$location_type = $location_types[ $rule['param'] ];
if ( ! isset( $location_type->object_type ) || $location_type->object_type !== (string) $object_type ) {
continue;
}
/**
* For posts/pages, we can only be sure that fields will show up if
* the field group is configured to show up for all items of the current
* post type.
*/
if ( 'post' === $object_type && 'post_type' === $rule['param'] ) {
if ( $rule['operator'] === '==' && $this->request->object_sub_type !== $rule['value'] ) {
continue;
}
if ( $rule['operator'] === '!=' && $this->request->object_sub_type === $rule['value'] ) {
continue;
}
$match = true;
}
if ( 'term' === $object_type && 'taxonomy' === $rule['param'] ) {
if ( $rule['operator'] === '==' && $this->request->object_sub_type !== $rule['value'] ) {
continue;
}
if ( $rule['operator'] === '!=' && $this->request->object_sub_type === $rule['value'] ) {
continue;
}
$match = true;
}
if ( 'user' === $object_type ) {
$match = true;
}
}
if ( $match ) {
return true;
}
}
return false;
}
/**
* Get all field groups for the provided object type.
*
* @param string $object_type 'user', 'term', or 'post'
*
* @return array An array of field groups that display for that location type.
*/
private function get_field_groups_by_object_type( $object_type ) {
$field_groups = acf_get_field_groups();
$location_types = acf_get_location_types();
$object_type_groups = array();
foreach ( $field_groups as $field_group ) {
if ( ! $field_group['show_in_rest'] ) {
continue;
}
if ( $this->object_type_has_field_group( $object_type, $field_group, $location_types ) ) {
$object_type_groups[] = $field_group;
}
}
return $object_type_groups;
}
/**
* Get all field groups for a given object.
*
* @param int $object_id
* @param string $object_type 'user', 'term', or 'post'
* @param string|null $object_sub_type The post type or taxonomy. When an $object_type of 'user' is in play, this can be ignored.
* @param array $scope Field group keys to limit the returned set of field groups to. This is used to scope field lookups to specific groups.
* @return array An array of matching field groups.
*/
private function get_field_groups_by_id( $object_id, $object_type, $object_sub_type = null, $scope = array() ) {
// When dealing with a term, we need the taxonomy in order to look up the relevant field groups. The taxonomy is expected
// in the $object_sub_type variable but when building our schema, this isn't readily available. This block ensures the
// taxonomy is set when not passed in.
if ( $object_type === 'term' && $object_sub_type === null ) {
$term = get_term( $object_id );
if ( ! $term instanceof WP_Term ) {
return array();
}
$object_sub_type = $term->taxonomy;
}
switch ( $object_type ) {
case 'user':
$args = array(
'user_id' => $object_id,
'rest' => true,
);
break;
case 'term':
$args = array( 'taxonomy' => $object_sub_type );
break;
case 'post':
default:
$args = array( 'post_id' => $object_id );
$child_rest_base = $this->request->get_url_param( 'child_rest_base' );
if ( $child_rest_base && 'post' === $object_type ) {
$args['post_type'] = $object_sub_type;
}
}
// Only return field groups that are configured to show in REST.
return array_filter(
acf_get_field_groups( $args ),
function ( $group ) use ( $scope ) {
if ( $scope and ! in_array( $group['key'], $scope ) ) {
return false;
}
return $group['show_in_rest'];
}
);
}
/**
* Get all ACF fields for a given field group and allow third party filtering.
*
* @param array $field_group This could technically be other possible values supported by acf_get_fields() but in this
* context, we're only using the field group arrays.
* @param null|int $object_id The ID of the object being prepared.
* @return array
*/
private function get_fields( $field_group, $object_id = null ) {
// Get all fields for this field group that are rest enabled.
$fields = array_filter(
acf_get_fields( $field_group ),
function ( $field ) {
$field_type = acf_get_field_type( $field['type'] );
return isset( $field_type->show_in_rest ) && $field_type->show_in_rest;
}
);
// Set up context array for use in the filter below.
$resource = array(
'type' => $this->request->object_type,
'sub_type' => $this->request->object_sub_type,
'id' => $object_id,
);
$http_method = $this->request->http_method;
/**
* Filter the fields available to the REST API.
*
* @param array $fields The ACF fields for this field group.
* @param array $resource Contextual information about the current resource request.
* @param string $http_method The HTTP method of the current request (GET, POST, PUT, PATCH, DELETE, OPTION, HEAD).
*/
return (array) apply_filters( 'acf/rest/get_fields', $fields, $resource, $http_method );
}
}