# register_meta()

URL: https://chugunov.pro/api-wordpress/functions/register_meta/
Проверено на WordPress 6.9, обновлено 06.08.2026.
Источник: независимый русскоязычный справочник chugunov.pro. Не является официальной документацией WordPress.

Тип: функция.
Появился в версии: 3.3.0.

## Сигнатура

```php
register_meta( string $object_type, string $meta_key, array $args, string|array $deprecated = null ): bool
```

## Описание

Рекомендуется регистрировать ключи метаданных для конкретного сочетания типа объекта и подтипа объекта. Если подтип объекта не передан, ключ метаданных регистрируется для всего типа объекта, однако он может быть частично переопределён, если для того же типа объекта и подтипа существует более специфичный ключ метаданных с тем же именем.
Если тип объекта не поддерживает подтипы, как, например, блоги, пользователи или комментарии, обычно эту функцию следует вызывать без передачи подтипа.

## Параметры

- `$object_type` `string` — обязательный. Тип объекта, к которому относятся метаданные. Принимает 'blog', 'post', 'comment', 'term', 'user' или любой другой тип объекта со связанной таблицей метаданных.
- `$meta_key` `string` — обязательный. Ключ метаданных для регистрации.
- `$args` `array` — обязательный. Данные, описывающие ключ метаданных при регистрации.
  
  object_subtype stringПодтип; например, если тип объекта — "post", то тип записи. Если оставить пустым, ключ метаданных будет зарегистрирован для всего типа объекта. По умолчанию пусто.
  
  type stringТип данных, связанных с этим ключом метаданных.
  
  Допустимые значения: 'string', 'boolean', 'integer', 'number', 'array' и 'object'.
  
  label stringЧитаемая человеком метка данных, связанных с этим ключом метаданных.
  
  description stringОписание данных, связанных с этим ключом метаданных.
  
  single boolИмеет ли ключ метаданных одно значение на объект или массив значений на объект.
  
  default mixedЗначение по умолчанию, возвращаемое из get_metadata(), если значение ещё не было задано.
  
  При использовании ключа метаданных с несколькими значениями значение по умолчанию относится к первой записи.
  
  Иными словами, при вызове get_metadata() с $single, равным false, указанное здесь значение по умолчанию будет обёрнуто в массив.
  
  sanitize_callback callableФункция или метод, вызываемые при очистке данных $meta_key.
  
  auth_callback callableНеобязательный. Функция или метод, вызываемые при проверке прав доступа edit_post_meta, add_post_meta и delete_post_meta.
  
  show_in_rest bool|arrayМогут ли данные, связанные с этим ключом метаданных, считаться публичными и быть доступными через REST API. Пользовательский тип записи также должен объявлять поддержку произвольных полей, чтобы зарегистрированные метаданные были доступны через REST.
  
  При регистрации сложных значений метаданных этот аргумент может при необходимости быть массивом с ключами 'schema' или 'prepare_callback' вместо логического значения.
  
  revisions_enabled boolВключать ли поддержку ревизий для этого meta_key. Может использоваться только когда тип объекта — 'post'.
- `$deprecated` `string|array` — необязательный, по умолчанию `null`. Устаревший. Используйте $args вместо этого.

## Возвращаемое значение

`bool`

## Исходный код

Файл: `wp-includes/meta.php:1435`

```php
function register_meta( $object_type, $meta_key, $args, $deprecated = null ) {
	global $wp_meta_keys;

	if ( ! is_array( $wp_meta_keys ) ) {
		$wp_meta_keys = array();
	}

	$defaults = array(
		'object_subtype'    => '',
		'type'              => 'string',
		'label'             => '',
		'description'       => '',
		'default'           => '',
		'single'            => false,
		'sanitize_callback' => null,
		'auth_callback'     => null,
		'show_in_rest'      => false,
		'revisions_enabled' => false,
	);

	// There used to be individual args for sanitize and auth callbacks.
	$has_old_sanitize_cb = false;
	$has_old_auth_cb     = false;

	if ( is_callable( $args ) ) {
		$args = array(
			'sanitize_callback' => $args,
		);

		$has_old_sanitize_cb = true;
	} else {
		$args = (array) $args;
	}

	if ( is_callable( $deprecated ) ) {
		$args['auth_callback'] = $deprecated;
		$has_old_auth_cb       = true;
	}

	/**
	 * Filters the registration arguments when registering meta.
	 *
	 * @since 4.6.0
	 *
	 * @param array  $args        Array of meta registration arguments.
	 * @param array  $defaults    Array of default arguments.
	 * @param string $object_type Type of object metadata is for. Accepts 'blog', 'post', 'comment', 'term',
	 *                            'user', or any other object type with an associated meta table.
	 * @param string $meta_key    Meta key.
	 */
	$args = apply_filters( 'register_meta_args', $args, $defaults, $object_type, $meta_key );
	unset( $defaults['default'] );
	$args = wp_parse_args( $args, $defaults );

	// Require an item schema when registering array meta.
	if ( false !== $args['show_in_rest'] && 'array' === $args['type'] ) {
		if ( ! is_array( $args['show_in_rest'] ) || ! isset( $args['show_in_rest']['schema']['items'] ) ) {
			_doing_it_wrong( __FUNCTION__, __( 'When registering an "array" meta type to show in the REST API, you must specify the schema for each array item in "show_in_rest.schema.items".' ), '5.3.0' );

			return false;
		}
	}

	$object_subtype = ! empty( $args['object_subtype'] ) ? $args['object_subtype'] : '';
	if ( $args['revisions_enabled'] ) {
		if ( 'post' !== $object_type ) {
			_doing_it_wrong( __FUNCTION__, __( 'Meta keys cannot enable revisions support unless the object type supports revisions.' ), '6.4.0' );

			return false;
		} elseif ( ! empty( $object_subtype ) && ! post_type_supports( $object_subtype, 'revisions' ) ) {
			_doing_it_wrong( __FUNCTION__, __( 'Meta keys cannot enable revisions support unless the object subtype supports revisions.' ), '6.4.0' );

			return false;
		}
	}

	// If `auth_callback` is not provided, fall back to `is_protected_meta()`.
	if ( empty( $args['auth_callback'] ) ) {
		if ( is_protected_meta( $meta_key, $object_type ) ) {
			$args['auth_callback'] = '__return_false';
		} else {
			$args['auth_callback'] = '__return_true';
		}
	}

	// Back-compat: old sanitize and auth callbacks are applied to all of an object type.
	if ( is_callable( $args['sanitize_callback'] ) ) {
		if ( ! empty( $object_subtype ) ) {
			add_filter( "sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $args['sanitize_callback'], 10, 4 );
		} else {
			add_filter( "sanitize_{$object_type}_meta_{$meta_key}", $args['sanitize_callback'], 10, 3 );
		}
	}

	if ( is_callable( $args['auth_callback'] ) ) {
		if ( ! empty( $object_subtype ) ) {
			add_filter( "auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $args['auth_callback'], 10, 6 );
		} else {
			add_filter( "auth_{$object_type}_meta_{$meta_key}", $args['auth_callback'], 10, 6 );
		}
	}

	if ( array_key_exists( 'default', $args ) ) {
		$schema = $args;
		if ( is_array( $args['show_in_rest'] ) && isset( $args['show_in_rest']['schema'] ) ) {
			$schema = array_merge( $schema, $args['show_in_rest']['schema'] );
		}

		$check = rest_validate_value_from_schema( $args['default'], $schema );
		if ( is_wp_error( $check ) ) {
			_doing_it_wrong( __FUNCTION__, __( 'When registering a default meta value the data must match the type provided.' ), '5.5.0' );

			return false;
		}

		if ( ! has_filter( "default_{$object_type}_metadata", 'filter_default_metadata' ) ) {
			add_filter( "default_{$object_type}_metadata", 'filter_default_metadata', 10, 5 );
		}
	}

	// Global registry only contains meta keys registered with the array of arguments added in 4.6.0.
	if ( ! $has_old_auth_cb && ! $has_old_sanitize_cb ) {
		unset( $args['object_subtype'] );

		$wp_meta_keys[ $object_type ][ $object_subtype ][ $meta_key ] = $args;

		return true;
	}

	return false;
}
```

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

- 6.7.0 — The label argument was added to the arguments array.
- 6.4.0 — The $revisions_enabled argument was added to the arguments array.
- 5.5.0 — The $default argument was added to the arguments array.
- 5.3.0 — Valid meta types expanded to include "array" and "object".
- 4.9.8 — The $object_subtype argument was added to the arguments array.
- 4.6.0 — Modified to support an array of data to attach to registered meta keys. Previous arguments for $sanitize_callback and $auth_callback have been folded into this array.
- 3.3.0 — Introduced.

## Связанные

Использует: [`rest_validate_value_from_schema`](https://chugunov.pro/api-wordpress/functions/rest_validate_value_from_schema/), [`has_filter`](https://chugunov.pro/api-wordpress/functions/has_filter/), [`post_type_supports`](https://chugunov.pro/api-wordpress/functions/post_type_supports/), [`is_protected_meta`](https://chugunov.pro/api-wordpress/functions/is_protected_meta/), [`__`](https://chugunov.pro/api-wordpress/functions/__/), [`_doing_it_wrong`](https://chugunov.pro/api-wordpress/functions/_doing_it_wrong/), [`wp_parse_args`](https://chugunov.pro/api-wordpress/functions/wp_parse_args/), [`apply_filters`](https://chugunov.pro/api-wordpress/functions/apply_filters/), [`add_filter`](https://chugunov.pro/api-wordpress/functions/add_filter/), [`is_wp_error`](https://chugunov.pro/api-wordpress/functions/is_wp_error/).
Используется в: [`wp_create_initial_comment_meta`](https://chugunov.pro/api-wordpress/functions/wp_create_initial_comment_meta/), [`wp_register_persisted_preferences_meta`](https://chugunov.pro/api-wordpress/functions/wp_register_persisted_preferences_meta/), [`register_term_meta`](https://chugunov.pro/api-wordpress/functions/register_term_meta/), [`register_post_meta`](https://chugunov.pro/api-wordpress/functions/register_post_meta/).

Оригинал в официальной документации: https://developer.wordpress.org/reference/functions/register_meta/