wpseek.com
A WordPress-centric search engine for devs and theme authors



register_rest_field › WordPress Function

Since4.7.0
Deprecatedn/a
› register_rest_field ( $object_type, $attribute, $args = array() )
Parameters: (3)
  • (string|array) $object_type Object(s) the field is being registered to, "post"|"term"|"comment" etc.
    Required: Yes
  • (string) $attribute The attribute name.
    Required: Yes
  • (array) $args { Optional. An array of arguments used to handle the registered field. @type callable|null $get_callback Optional. The callback function used to retrieve the field value. Default is 'null', the field will not be returned in the response. The function will be passed the prepared object data. @type callable|null $update_callback Optional. The callback function used to set and update the field value. Default is 'null', the value cannot be set or updated. The function will be passed the model object, like WP_Post. @type array|null $schema Optional. The schema for this field. Default is 'null', no schema entry will be returned. }
    Required: No
    Default: array()
Defined at:
Codex:

Registers a new field on an existing WordPress object type.



Related Functions: register_rest_route, register_post_type, register_block_core_file, register_post_meta, register_meta

Source 

function register_rest_field( $object_type, $attribute, $args = array() ) {
	global $wp_rest_additional_fields;

	$defaults = array(
		'get_callback'    => null,
		'update_callback' => null,
		'schema'          => null,
	);

	$args = wp_parse_args( $args, $defaults );

	$object_types = (array) $object_type;

	foreach ( $object_types as $object_type ) {
		$wp_rest_additional_fields[ $object_type ][ $attribute ] = $args;
	}
}