get_the_archive_description()
Отримує опис сторінок архівів: типів записів, міток, рубрик, елементів таксономій чи архів автора.
Призначений для використання на сторінках архівів елементів таксономій (включаючи рубрики та мітки), архівів типів записів або архіву автора.
На сторінці автора опис береться з поля “Біографія” (description). У елементів таксономії поля «Опис» (description). Типи записів з функції get_the_post_type_description() .
Використовуйте обгортку the_archive_description() , щоб одразу вивести результат на екран.
the_archive_description()
Хуки з функції
Повертає
Строку. Опис для сторінки архіву.
Використання
$desc = get_the_archive_description();
Приклади
#1 Виведемо опис на будь-якій сторінці архіву (крім архіву за датами)
Допустимо нам потрібно одним кодом вивести опис для всіх рубрик, міток, таксономій або авторів, якщо такий опис є…
$description = get_the_archive_description();
if ($description) {
echo "Зображення: $description";
}Але краще для таких цілей використовувати обгортку для цієї функції: the_archive_description() . В даному випадку можна просто використовувати параметр $before , щоб додати текст перед описом.
нотатки
- Дивіться: term_description()
список змін
| З версії 4.1.0 | Введено. |
| З версії 4.7.0 | Added support for author archives. |
| З версії 4.9.0 | Added support for post type archives. |
Код get_the_archive_description() get the archive description WP 6.0.2
function get_the_archive_description() {
if ( is_author() ) {
$description = get_the_author_meta( 'description' );
} elseif ( is_post_type_archive() ) {
$description = get_the_post_type_description();
} else {
$description = term_description();
}
/**
* Filters the archive description.
*
* @ Since 4.1.0
*
* @param string $description Archive description to be displayed.
*/
return apply_filters( 'get_the_archive_description', $description );
}