get_the_archive_description() WP 4.1.0
Получает описание для страниц архивов: типов записей, меток, рубрик, элементов таксономий или архив автора.
Предназначен для использования на страницах архивов элементов таксономий (включая рубрики и метки), архивов типов записей или архива автора.
На странице автора описание берется из поля «Биография» (description). У элементов таксономии их поля «Описание» (description). У типов записей из функции get_the_post_type_description().
Используйте обертку the_archive_description(), чтобы сразу вывести результат на экран.
Хуки из функции
Возвращает
Строку. Описание для страницы архива.
Использование
$desc = get_the_archive_description();
Примеры
#1 Выведем описание на любой странице архива (кроме архива по датам)
Допустим нам нужно одним кодом вывести описание для всех рубрик, меток, таксономий или авторов, если такое описание есть...
$description = get_the_archive_description();
if ( $description ) {
echo "The description: $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 5.6.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 );
}