category_description()
Отримує опис рубрики, який вказується на сторінці редагування рубрики на адмін-панелі (пости > рубрики).
Якщо category_description() використовується на сторінці архівів, відмінної від category.php, то перед тим як використовувати функцію потрібно перевірити, що генерується сторінка категорій, а не якась сторінка міток, авторів, дат тощо. Зробити це можна умовним тегом is_category() .
term_description()
Хуків немає.
Повертає
Строку. Опис категорії.
Використання
$description = category_description( $category_id );
-
$category_id
(число) -
ID категорії, опис якої потрібно отримати.
За замовчуванням: поточна категорія (за запитом)
Приклади
#1 Звичайний приклад використання
Виведемо на екран опис категорії 3 (id категорії), використовуючи оператор echo. echo потрібний для виведення опису категорії на екран, тому що функція просто повертає опис і нічого не виводить.
<?php echo category_description(3); ?>
В результаті отримаємо опис категорії 3.
#2 Виводимо опис категорії, тільки якщо він є
if ( $cat_desc = category_description() ) echo '<div class="cat__desc">'. $cat_desc .'</div>'; else echo '<div class="no__cat__desc">Опис відсутній!</div>';
#3 Опис категорії отриманої через ярлик
Виведемо на екран опис категорії (рубрики), використовуючи склад (альтернативну назву категорії), а не ID як у попередньому прикладі. Для цього отримаємо ID за допомогою функції get_category_by_slug() .
<?php echo category_description( get_category_by_slug('category-slug')->term_id ); ?>Примітка: це скоріше наочний приклад і використовувати його я не рекомендую, тому що немає необхідності отримувати всі дані категорії лише для того, щоб отримати ID категорії.
Приклад вище можна також замінити на цей, теж буде отримано опис категорії за складом:
<?php echo get_category_by_slug('category-slug')->description; ?> #4 Очистимо опис категорії при виведенні через фільтрterm_description
Допустимо у нас в описі категорії використовується шоткод [image=/посилання_на_картинку] ми використовуємо цей шоткод в інших місцях, але коли ми виводимо опис категорії, він нам не потрібен. Щоб його прибрати скористаємося фільтром:
add_filter('term_description', 'clear_term_description_image_shortcode');
function clear_term_description_image_shortcode($value){
return preg_replace('@[image=[^]]*]@', '', $value);
}
список змін
| З версії 1.0.0 | Введено. |
Код category_description() category description WP 6.0.2
function category_description( $category = 0 ) {
return term_description( $category );
}