# Получение описания архива в WordPress (GET_THE_ARCHIVE_DESCRIPTION)
Функция get_the_archive_description() позволяет получить описание страниц архивов постов, категорий, меток, терминов или авторов. Эта функция полезна при работе с архивами таксономий (категории и метки), поста��и и страницами авторов.
### Как работает функция
- **На страницах авторов**: Описание берётся из поля "Биографическая информация" автора.
- **На страницах архивов таксономий**: Используется поле "Описание".
- **На страницах архивов постов**: Для получения описания применяется функция get_the_post_type_description().
Чтобы отобразить описание архива, рекомендуется использовать функцию-обёртку the_archive_description().
### Используемые функции
- get_the_author_meta(): Получает информацию об авторе.
- term_description(): Получает описание термина.
### Слушатели функции
Функция get_the_archive_description может иметь подключенные слушатели, которые могут модифицировать возвращаемое значение.
### Возвращаемое значение
Функция возвращает строку — описание архива.
### Пример использования
Чтобы вывести описание на страницах архива (кроме страниц с архивами по дате), можно использовать следующий код:
```php
$description = get_the_archive_description();
if ( $description ) {
echo "Описание: $description";
}Однако, если вам необходимо просто отобразить описание, лучше использовать the_archive_description(). В этом случае можно добавить свой текст перед описанием с помощью параметра $before.
Примечания
- Для получения описания термина стоит использовать функцию
term_description().
История изменений
- С версии 4.1.0: Функция была введена.
- С версии 4.7.0: Добавлена поддержка архивов авторов.
- С версии 4.9.0: Добавлена поддержка архивов типов постов.
Код функции
Вот код самой функции get_the_archive_description(), который можно найти в файле wp-includes/general-template.php:
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();
}
/**
* Фильтрует описание архива.
*
* @since 4.1.0
*
* @param string $description Описание архива для отображения.
*/
return apply_filters( 'get_the_archive_description', $description );}
Связанные функции
category_description(): Получить описание категории.tag_description(): Получить описание метки.the_archive_description(): Отобразить описание архива.get_the_archive_title(): Получить заголовок архива.
Функция get_the_archive_description() — полезный инструмент для создания более информативных страниц архивов в WordPress. Используйте её для улучшения отображаемой информации на вашем сайте.