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

相关方法: register_rest_route register_post_meta register_block_core_file register_post_type register_sidebar

引入: 4.7.0

弃用: -

register_rest_field: 这个函数允许开发人员将自定义字段添加到WordPress REST API响应中。自定义字段可以用来给响应添加额外的数据，如文章元数据或自定义字段。

在现有的WordPress对象类型上注册一个新字段。

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

register_rest_field

WP开发教程