Функция the_archive_description() в WordPress 4.1.0
Описание функции
Функция the_archive_description() используется для отображения описания архивной страницы постов, категорий, тегов или авторов.
Эта функция может быть полезной для отображения описания архивной страницы любого типа в вашей теме.
- На странице архива автора описание извлекается из поля "Биографическая информация".
- На страницах архивов таксономий (категорий и тегов) описание берется из соответствующего поля описания.
- Для архивов постов используется функция
get_the_post_type_description().
Возвращаемое значение
Функция возвращает значение: null (ничего).
Использование
Синтаксис
the_archive_description( $before, $after );$before(строка) — содержимое, которое будет добавлено перед описанием. По умолчанию:''$after(строка) — содержимое, которое будет добавлено после описания. По умолчанию:''
Примеры использования
Пример 1: Отображение описания архивной страницы
Функция отображает описание для тегов, категорий, таксономий или авторов. Обратите внимание, что у архивов по дате нет описания, так как в админке нет поля для его ввода. Обычно описание для архивов по дате не используется на сайтах. Подробности можно узнать из кода функции get_the_archive_description().
Заметки
- Ознакомьтесь с функцией
get_the_archive_description()для получения подробной информации.
Изменения
- С версии 4.1.0 — были внесены изменения и улучшения.
Код функции the_archive_description()
Вот как выглядит реализация функции:
function the_archive_description( $before = '', $after = '' ) {
$description = get_the_archive_description();
if ( $description ) {
echo $before . $description . $after;
}
}Связанные функции
category_description()— получение описания категории.get_the_archive_description()— получение описания архивной страницы.tag_description()— получение описания тега.term_description()— получение описания термина.
Заключение
Функция the_archive_description() — это полезный инструмент для улучшения общения с посетителями вашего сайта на WordPress. Она позволяет добавлять контекстную информацию к архивным страницам, делая их более информативными и удобными для пользователей.