ACF_Rest_Api

---

• Properties
• $request
• $embed_links
• $rest_update_plan
• Methods
• register_field
• get_schema
• validate_rest_arg
• load_fields
• check_bidirectional_target_permissions
• prepare_field_updates
• update_fields
• make_identifier
• object_type_has_field_group
• get_field_groups_by_object_type
• get_field_groups_by_id
• get_fields

---

Properties

$request

• @var ACF_Rest_Request

$embed_links

• @var ACF_Rest_Embed_Links

$rest_update_plan

Fields and updates resolved during the current REST request.

• @since SCF 6.9.5
• @var array|null

Methods

register_field

Register our custom property as a REST field.

get_schema

Dynamically generate the schema for the current request.

• @return array

validate_rest_arg

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 boolean|WP_Error

load_fields

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

check_bidirectional_target_permissions

Check bidirectional target permissions before the REST callback runs.

• @since SCF 6.9.5
• @param mixed $dispatch_result Result from an earlier dispatch filter.
• @param WP_REST_Request $request Current REST request.
• @return mixed|WP_Error

prepare_field_updates

Resolve incoming values against fields active for the REST object.

• @since SCF 6.9.5
• @param array $data Incoming ACF field values.
• @param integer $object_id Object ID, or zero for a create request.
• @param string $object_type ACF object type.
• @param string $object_sub_type Post type, taxonomy, or user.
• @return array Field, value, and submitted field name tuples.

update_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 boolean|WP_Error

make_identifier

Make the ACF identifier string for the given object.

• @param integer $object_id
• @param string $object_type 'user', 'term', or 'post'
• @return string

object_type_has_field_group

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 boolean

get_field_groups_by_object_type

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.

get_field_groups_by_id

Get all field groups for a given object.

• @param integer $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.

get_fields

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|integer $object_id The ID of the object being prepared.
• @return array