Eine auf WordPress spezialiserte Suchmaschine für Entwickler und Theme-Autoren



register_rest_field ›

Seit4.7.0
Veraltetn/v
register_rest_field ( $object_type, $attribute, $args = array() )
Parameter: (3)
  • (string|array) $object_type Object(s) the field is being registered to, "post"|"term"|"comment" etc.
    Erforderlich: Ja
  • (string) $attribute The attribute name.
    Erforderlich: Ja
  • (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 callback function used to create the schema for this field. Default is 'null', no schema entry will be returned. }
    Erforderlich: Nein
    Standard: array()
Definiert in:
Codex:

Registers a new field on an existing WordPress object type.



Quellcode

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;
	}
}