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

Сигнатура

get_tag( int|WP_Term|object $tag, string $output = OBJECT, string $filter = 'raw' ): WP_Term|array|WP_Error|null

Описание

Если передать в параметр $tag объект, который считается объектом строки метки, полученной из базы данных, данные метки будут закэшированы.
Если передать в $tag целочисленный идентификатор метки, эта метка будет извлечена из базы данных, если она ещё не в кэше, и возвращена.
Если посмотреть на get_term(), оба типа проходят через несколько фильтров и в итоге очищаются в зависимости от значения параметра $filter.

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

If you pass the $tag parameter an object, which is assumed to be the tag row object retrieved from the database, it will cache the tag data.

If you pass $tag an integer of the tag ID, then that tag will be retrieved from the database, if it isn’t already cached, and passed back.

If you look at get_term() , both types will be passed through several filters and finally sanitized based on the $filter parameter value.

Параметры

$tag int|WP_Term|object обязательный

Идентификатор метки или объект.

$output string необязательный = OBJECT

Требуемый тип возврата. Один из OBJECT, ARRAY_A или ARRAY_N, что соответствует объекту WP_Term, ассоциативному массиву или числовому массиву соответственно.

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

Как очищать поля метки. По умолчанию 'raw'.

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

WP_Term|array|WP_Error|null

WP_Error

Исходный код

wp-includes/category.php:341

function get_tag( $tag, $output = OBJECT, $filter = 'raw' ) {
	return get_term( $tag, 'post_tag', $output, $filter );
}

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

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