register_rest_field

Advertisement

Summery Summery

Registers a new field on an existing WordPress object type.

Syntax Syntax

register_rest_field( string|array $object_type, string $attribute, array $args = array() )

Parameters Parameters

$object_type

(string|array) (Required) Object(s) the field is being registered to, "post"|"term"|"comment" etc.

$attribute

(string) (Required) The attribute name.

$args

(array) (Optional) An array of arguments used to handle the registered field.

  • 'get_callback'
    (callable|null) 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.
  • 'update_callback'
    (callable|null) 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.
  • 'schema'
    (array|null) Optional. The callback function used to create the schema for this field. Default is 'null', no schema entry will be returned.

Default value: array()

Source Source

File: wp-includes/rest-api.php

 * @since 4.7.0
 *
 * @global array $wp_rest_additional_fields Holds registered fields, organized
 *                                          by object type.
 *
 * @param string|array $object_type Object(s) the field is being registered
 *                                  to, "post"|"term"|"comment" etc.
 * @param string       $attribute   The attribute name.
 * @param 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.

Advertisement

Changelog Changelog

Changelog
Version Description
4.7.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.