register_rest_field() — описание функции WordPress на русском

Сигнатура

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

Описание

Регистрирует новое поле для существующего типа объекта WordPress.

Параметры

$object_type string|array обязательный

Объект(ы), для которых регистрируется поле: "post"|"term"|"comment" и т. д.

$attribute string обязательный

Имя атрибута.

$args array необязательный = array()

Массив аргументов, используемых для обработки зарегистрированного поля. get_callback callable|nullНеобязательный. Функция обратного вызова для получения значения поля. Значение по умолчанию — 'null', поле не будет возвращено в ответе. Функции будут переданы подготовленные данные объекта. update_callback callable|nullНеобязательный. Функция обратного вызова для установки и обновления значения поля. Значение по умолчанию — 'null', значение нельзя установить или обновить. Функции будет передан объект модели, например WP_Post. schema array|nullНеобязательный. Схема для этого поля. Значение по умолчанию — 'null', запись схемы не будет возвращена.

Исходный код

wp-includes/rest-api.php:182

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

История изменений

Версия	Описание
4.7.0	Introduced.