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

Сигнатура

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

Описание

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

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

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

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

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

Параметры

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

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

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

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

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

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

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

WP_Term|array|WP_Error|null

WP_Term WP_Error

Исходный код

wp-includes/category.php:92

function get_category( $category, $output = OBJECT, $filter = 'raw' ) {
	$category = get_term( $category, 'category', $output, $filter );

	if ( is_wp_error( $category ) ) {
		return $category;
	}

	_make_cat_compat( $category );

	return $category;
}

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

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