term_description()
Отримує опис терміну (елемента таксономії: мітки, категорії тощо), який вказується на сторінці створення/редагування терміну.
Якщо не вказано параметр $term_id , буде отримано опис поточного терміна (поточної рубрики, мітки тощо).
Фільтри
Для фільтрації результату використовуйте такі фільтри:
Ці фільтри використовуються у функції sanitize_term_field() , яка спрацьовує в результаті роботи цієї функції.
get_term_field()
get_the_archive_description() ,
tag_description() ,
Хуків немає.
Повертає
Строку. Опис терміну або пусто – ''.
Використання
term_description ($ term, $ deprecated);
-
$term
(число/об’єкт) -
ID або об’єкт терміна (елемента таксономії), опис якого необхідно отримати.
Якщо цей параметр не вказати, то функція спробує отримати опис терміну, який наразі перебуває у запиті. Наприклад, якщо відображається сторінка категорії SEO, функція отримає опис цієї категорії.
За замовчуванням: ID поточного терміна у запиті -
$deprecated
(рядок) З версії 4.9.2 цей параметр застарів, він не потрібен (у ньому немає сенсу).
До цього тут був параметр $taxonomy – Назва таксономії, до якої належить термін, опис якого потрібно отримати. Можливо:
category,post_tag,link_categoryабопроизвольная таксономия. Якщо параметр $term не вказано , цей параметр дорівнює назві таксономії поточного терміна. За умовчанням дорівнював post_tag .
Типово: null
Приклади
#1 Отримаємо опис поточного терміна (категорії, мітки тощо):
$description = term_description(); echo $description;
#2 Виведемо на екран опис розділу таксономії my_tax, ID якого дорівнює 28:
echo 'Опис розділу: ' . term_description('28', 'my_tax');
список змін
| З версії 2.8.0 | Введено. |
| З версії 4.9.2 | $taxonomy parameter був deprecated. |
Код term_description() term description WP 6.0.2
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;
}