term_description

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

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

Хуков нет.

Возвращает

Строку. Описание термина или пусто (”).

Фильтры

Для фильтрации результата используйте следующие фильтры: term_(field) или (taxonomy)_(field). Эти фильтры применяются в функции sanitize_term_field(), которая срабатывает в результате работы term_description().

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

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

Название таксономии, к которой принадлежит термин, описание которого нужно получить. Может быть: category, post_tag, link_category или произвольная таксономия.

Если не указан параметр $term, этот параметр будет равен названию таксономии текущего термина.
По умолчанию: ‘post_tag’

Примеры

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

$description = term_description();
echo $description;

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

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

Код из


wp-includes/category-template.php

WP 4.7.2

<?php
function term_description( $term = 0, $taxonomy = 'post_tag' ) {
	if ( ! $term && ( is_tax() || is_tag() || is_category() ) ) {
		$term = get_queried_object();
		if ( $term ) {
			$taxonomy = $term->taxonomy;
			$term = $term->term_id;
		}
	}
	$description = get_term_field( 'description', $term, $taxonomy );
	return is_wp_error( $description ) ? '' : $description;
}

Комментарии:


Оставить комментарий

Your email address will not be published. Required fields are marked *