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()
定義位置
相關方法
register_rest_routeregister_post_metaregister_block_core_fileregister_post_typeregister_sidebar
引入
4.7.0
棄用
-

register_rest_field: 這個函式允許開發人員將自定義欄位新增到WordPress REST API響應中。自定義欄位可以用來給響應新增額外的資料,如文章後設資料或自定義欄位。

在現有的WordPress物件型別上註冊一個新欄位。

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
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;
}
}
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; } }
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;
	}
}

常見問題

FAQs
檢視更多 >