Функция single_tag_title() в WordPress предназначена для вывода или получения заголовка страницы архива метки (тега). Она часто используется в файлах шаблонов для страниц архивов меток, чтобы динамически отображать заголовок, соответствующий текущей метке.
single_tag_title( string $prefix = '', bool $display = true ): string|void
Параметры
- $prefix (необязательный) — текст, который будет отображён перед заголовком метки. Если нужно добавить пробел между префиксом и заголовком, это нужно учитывать в значении
$prefix. - $display (необязательный) — определяет, будет ли заголовок выведен на экран или возвращён для использования в PHP. По умолчанию
true(вывод на экран).
Возвращаемые значения
- Строка — заголовок метки, если параметр
$displayустановлен вfalse. - Ничего — если заголовок выведен на экран (по умолчанию).
Особенности работы
- Функция полезна при создании файлов шаблонов для меток (архивов меток) и позволяет автоматически отображать название метки на таких страницах.
- Если требуется использовать полученный заголовок в переменной для последующей обработки, достаточно установить параметр
$displayвfalse.
Пример 1: Вывод заголовка метки с префиксом
Предположим, мы находимся на странице архива метки «Рецепты». Для вывода текста с заголовком метки можно использовать следующий код:
<p><?php single_tag_title('Вы просматриваете метку: '); ?>.</p>
Пример 2: Получение заголовка метки в переменную
В некоторых случаях может потребоваться сохранить заголовок метки в переменной для дальнейшего использования. Для этого можно сделать так:
<?php
$current_tag = single_tag_title("", false);
?>
Значение заголовка метки будет сохранено в переменной $current_tag, и его можно использовать в любом месте кода. При этом заголовок не будет автоматически выведен на экран.
Пример 3: Использование функции без префикса
Если вам не нужен текст перед заголовком, можно просто вызвать функцию без передачи параметров:
<?php single_tag_title(); ?>
В этом случае на странице будет выведен только заголовок текущей метки, например, «Продвижение сайтов».
Пример 4: Добавление перевода в префикс
В случае, если сайт поддерживает несколько языков, префикс можно перевести с использованием функции __():
<p><?php single_tag_title( __( 'Текущая метка: ', 'textdomain' ) ); ?></p>
Заключение
Функция single_tag_title() — это удобный инструмент для динамического вывода заголовков меток на страницах архивов в WordPress. Она поддерживает кастомизацию вывода через параметр $prefix и может возвращать заголовок метки для использования в переменных. Эта функция особенно полезна для создания шаблонов, где требуется отображать или обрабатывать заголовки меток.