Функция post_type_archive_title() была добавлена в WordPress начиная с версии 3.1.0. Она предназначена для генерации заголовка архивной страницы для произвольного типа записи, что позволяет легко адаптировать заголовки на страницах архивов.
string|null post_type_archive_title( string $prefix = '', bool $display = true )Параметры
- $prefix (string): Необязательный параметр. Текст, который будет добавлен перед заголовком архивной страницы. По умолчанию это пустая строка.
- $display (bool): Необязательный параметр. Определяет, будет ли заголовок выведен на экран (
true) или возвращен для последующей обработки (false). По умолчанию установлено вtrue.
Возвращаемое значение
Функция возвращает строку с заголовком архивной страницы для указанного типа записи. Если параметр $display установлен в false, функция вернет значение в виде строки, иначе выведет его на экран. В случае, если нет подходящего заголовка, функция может вернуть null.
Использование
Функция post_type_archive_title() идеально подходит для использования на страницах, где отображаются архивы типов записей, таких как archive.php и archive-{posttype}.php. Она служит основой для более общей функции wp_get_document_title().
Пример 1: Простое использование
Допустим, у вас зарегистрирован пользовательский тип записи с именем portfolio, и вы хотите добавить префикс к заголовку архивной страницы:
<?php
// Добавляем префикс к заголовку архивной страницы для типа записи 'portfolio'
echo post_type_archive_title( 'Архив проектов: ', false );
?>
Этот код вернет строку Архив проектов: Портфолио для страницы архива типа записи portfolio.
Пример 2: Возвращаем значение вместо вывода его на экран
Если вам нужно получить заголовок для дальнейшей обработки, например, для использования в переменной или в других функциях, установите параметр $display в false:
<?php
// Получаем заголовок архивной страницы и сохраняем его в переменной
$archive_title = post_type_archive_title( 'Архив: ', false );
// Используем заголовок в другом месте
echo '<h1>' . esc_html( $archive_title ) . '</h1>';
?>Заключение
Функция post_type_archive_title() является полезным инструментом для динамического управления заголовками архивных страниц в WordPress. Она упрощает работу с пользовательскими типами записей и позволяет легко адаптировать заголовки в зависимости от текущего контекста страницы.