Функция single_month_title() используется для вывода или получения заголовка страницы архива записей за определенный месяц и год. Она полезна при создании шаблонов для архивных страниц, где нужно отобразить заголовок, содержащий месяц и год публикаций.
<?php single_month_title( $prefix, $display ); ?>Описание
Функция выводит или возвращает заголовок текущей страницы архива, который состоит из месяца и года. Она работает только на страницах архивов по датам, когда передан параметр m (месяц), и не сработает на других страницах, таких как категории, метки или авторские архивы.
Параметры
$prefix(строка, необязательный):
Префикс, который выводится перед заголовком. По умолчанию пустая строка. Если нужно, чтобы между префиксом и заголовком была пробельная строка, её нужно добавить вручную, например,'Пример: '.$display(булевое значение, необязательный):
Определяет, выводить ли заголовок на экран (true) или вернуть его для дальнейшей обработки (false). По умолчаниюtrue(вывод на экран).
Возвращаемые значения
- Строка — если нужно получить заголовок.
false— если нет данных для отображения.null— если заголовок выведен на экран.
Пример 1: Базовый вывод заголовка страницы
Простой пример без префикса, функция выводит заголовок текущей страницы архива:
<?php single_month_title(); ?>Если текущая страница — архив записей за март 2024 года, то результат будет:
Март 2024Пример 2: Добавление префикса к заголовку
Используем префикс, чтобы добавить текст перед заголовком:
<?php single_month_title('Записи за: '); ?>
Результат для архива февраля 2024 года:
Записи за: Февраль 2024
Пример 3: Получение заголовка без вывода
Иногда может потребоваться получить заголовок, а не вывести его на экран. Для этого нужно передать параметр $display как false:
$title = single_month_title('', false);
echo '<h1>' . $title . '</h1>';
Этот код вернёт заголовок страницы архива в переменную $title, а затем выведет его в теге <h1>.
Заключение
Функция single_month_title() полезна для настройки заголовков архивных страниц по датам. С её помощью можно легко отобразить заголовок с месяцем и годом публикаций, добавлять к нему префиксы или форматировать с использованием HTML-тегов.