A WordPress-centric search engine for devs and theme authors



register_rest_field ›

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.
    Required: No
    Default: array()
Defined at:
Codex:

Registers a new field on an existing WordPress object type.



Source

function register_rest_field( $object_type, $attribute, $args = array() ) {
	$defaults = array(
		'get_callback'    => null,
		'update_callback' => null,
		'schema'          => null,
	);

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

	global $wp_rest_additional_fields;

	$object_types = (array) $object_type;

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