register_rest_field

函数


register_rest_field ( $object_type, $attribute, $args = array() )
参数
  • (string|array)
    $object_type
    Object(s) the field is being registered to, “post”|”term”|”comment” etc.
    Required: 是
  • (string)
    $attribute
    The attribute name.
    Required: 是
  • (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: 否
    Default: array()
定义位置
  • wp-includes/rest-api.php
    , line 153
引入
4.7.0
弃用
–

Registers a new field on an existing WordPress object type.

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;
	}
}
声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。