Функция header_image() выводит URL изображения шапки сайта (заголовка), которое установлено в настройках темы через кастомайзер. Это изображение может быть использовано в различных элементах сайта, таких как шапка (header) или фоновое изображение.
header_image(): void
Функция ничего не возвращает, она сразу выводит URL изображения. Если вам необходимо сохранить этот URL в переменной, используйте функцию get_header_image().
Описание
Функция выводит очищенный через esc_url() URL изображения, установленного как шапка сайта. Это изображение можно настроить в админке WordPress через раздел Внешний вид > Настроить (Appearance > Customize).
Функция работает только в том случае, если тема поддерживает возможность использования заголовочного изображения. Чтобы добавить такую поддержку в тему, нужно вызвать функцию add_theme_support( 'custom-header' ) в файле functions.php вашей темы.
Пример добавления поддержки заголовочного изображения
Чтобы включить возможность установки изображения шапки для вашей темы, добавьте следующий код в файл functions.php:
add_theme_support( 'custom-header' );
После этого в настройках темы в разделе Внешний вид > Настроить появится опция для установки изображения заголовка.
Возвращаемое значение
Функция ничего не возвращает, если:
- Текущая тема не поддерживает заголовочные изображения. Поддержка добавляется с помощью функции
add_theme_support( 'custom-header' ). - Для текущей темы не установлено изображение шапки. Изображение можно установить в разделе Внешний вид > Настроить.
Пример 1: Вывод изображения шапки
Если вам нужно вывести изображение шапки сайта в HTML-разметке, можно использовать следующую конструкцию:
<img src="<?php header_image(); ?>" alt="<?php bloginfo('title'); ?>">
Этот код выведет тег <img> с URL изображения шапки, установленного через кастомайзер, и добавит атрибут alt с названием вашего сайта, используя функцию bloginfo('title').
Пример 2: Проверка на наличие изображения
Для предотвращения вывода пустого тега <img>, когда изображение шапки не установлено, можно добавить проверку:
<?php if ( get_header_image() ) : ?>
<img src="<?php header_image(); ?>" alt="<?php bloginfo('title'); ?>">
<?php endif; ?>Этот код сначала проверяет, установлено ли изображение заголовка с помощью функции get_header_image(), и только если оно существует, выводит HTML-код для отображения изображения.
Использование в шаблонах темы
Обычно функция header_image() используется в файлах темы, таких как header.php, для динамической подгрузки изображения шапки. Например, если вы хотите использовать изображение заголовка в фоновом изображении элемента, можно написать такой код:
<header style="background-image: url('<?php header_image(); ?>');">
<h1><?php bloginfo('name'); ?></h1>
</header>
В этом примере фоновое изображение для тега <header> будет установлено в URL изображения шапки, заданного через кастомайзер.
Заключение
Функция header_image() — это удобный способ динамически выводить изображение заголовка, установленное через админку WordPress. Она автоматически очищает URL изображения и позволяет гибко использовать его в различных частях шаблона, будь то в виде тега <img> или как фон для элемента.