Kama и campusboy, Jackky2.4 года назад6 EN

term_description() │ WP 2.8.0

Получает описание термина (элемента таксономии: метки, категории и т.п.), которое указывается на странице создании/редактировании термина.

Если не указан параметр $term_id, то будет получено описание текущего термина (текущей рубрики, метки и т.д.).

Фильтры

Для фильтрации результата используйте следующие фильтры:

Эти фильтры применяются в функции sanitize_term_field(), которая срабатывает в результате работы этой функции.

Работает на основе: get_term_field()
Основа для: get_the_archive_description(), tag_description(), category_description()

Хуков нет.

Возвращает

Строку. Описание термина или пусто - ''.

Использование

term_description( $term, $deprecated );
$term(число/объект)
ID или объект термина (элемента таксономии), описание которого нужно получить.
Если этот параметр не указать, то функция попытается получить описание термина, который в данный момент находится в запросе. Например, если отображается страница категории "SEO", то функция получит описание этой категории.
По умолчанию: ID текущего термина в запросе
$deprecated(строка)

С версии 4.9.2 этот параметр устарел, он больше не нужен (в нем нет смысла).

До этого тут был параметр $taxonomy — Название таксономии, к которой принадлежит термин, описание которого нужно получить. Может быть: category, post_tag, link_category или произвольная таксономия. Если не указан параметр $term, этот параметр будет равен названию таксономии текущего термина. По умолчанию был равен post_tag.
По умолчанию: null

Примеры

1

#1 Получим описание текущего термина (категории, метки и т.п.): 

$description = term_description();
echo $description;
0

#2 Выведем на экран описание раздела таксономии my_tax, ID которого равен 28: 

echo 'Описание раздела: ' . term_description('28', 'my_tax');

Список изменений

С версии 2.8.0 Введена.
С версии 4.9.2 The $taxonomy parameter was deprecated.

Код term_description() WP 6.7.1

wp-includes/category-template.php 
function term_description( $term = 0, $deprecated = null ) {
	if ( ! $term && ( is_tax() || is_tag() || is_category() ) ) {
		$term = get_queried_object();
		if ( $term ) {
			$term = $term->term_id;
		}
	}

	$description = get_term_field( 'description', $term );

	return is_wp_error( $description ) ? '' : $description;
}

Описание (post term description)

Любые таксономии

Таксономии: рубрики, метки, ...

6 комментариев
    Войти