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

Сигнатура

get_metadata( string $meta_type, int $object_id, string $meta_key = '', bool $single = false ): mixed

Описание

Если поле метаданных существует, возвращается одно значение, когда $single равно true, или массив значений, когда оно равно false.
Если поле метаданных не существует, результат зависит от get_metadata_default() .
По умолчанию возвращается пустая строка, когда $single равно true, или пустой массив, когда оно равно false.
См. alsoget_metadata_raw()

get_metadata_default()

Оригинал (английский)

If the meta field exists, a single value is returned if $single is true, or an array of values if it’s false.

If the meta field does not exist, the result depends on get_metadata_default() .
By default, an empty string is returned if $single is true, or an empty array if it’s false.

Параметры

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

Тип объекта, к которому относятся метаданные. Принимает 'blog', 'post', 'comment', 'term', 'user' или любой другой тип объекта со связанной таблицей метаданных.

$object_id int обязательный

ID объекта, к которому относятся метаданные.

$meta_key string необязательный = ''

Ключ метаданных. Если не указан, получаются все метаданные для указанного объекта.

$single bool необязательный = false

Если true, возвращается только первое значение указанного $meta_key. Этот параметр не действует, если $meta_key не указан.

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

mixed

$single $single $object_id $meta_type $single $single значения false возвращаются как пустые строки ('') значения true возвращаются как '1' числа (как целые, так и с плавающей точкой) возвращаются как строки. Массивы и объекты сохраняют свой исходный тип.

Исходный код

wp-includes/meta.php:601

function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) {
	$value = get_metadata_raw( $meta_type, $object_id, $meta_key, $single );
	if ( ! is_null( $value ) ) {
		return $value;
	}

	return get_metadata_default( $meta_type, $object_id, $meta_key, $single );
}

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

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