Функция get_header_image() возвращает URL изображения, которое установлено в качестве заголовка сайта в настройках темы. Если изображение заголовка не установлено, функция вернет false.
get_header_image(): string|falseПримечание
Перед использованием функции get_header_image(), рекомендуется рассмотреть использование функции get_header_image_tag(), которая появилась в WordPress 4.4. Эта функция возвращает тег <img> с атрибутами srcset, что делает изображение адаптивным для разных экранов.
Возвращаемое значение
- string: URL изображения заголовка, если оно установлено.
- false: если изображение заголовка не поддерживается или не установлено.
Использование
Функция удобна для получения ссылки на изображение заголовка, которое затем можно использовать в шаблонах или для обработки. Если требуется вывести URL сразу на экран, можно использовать функцию header_image().
Вывод URL изображения заголовка:
$url = get_header_image();
if ( $url ) {
echo 'URL изображения заголовка: ' . esc_url( $url );
} else {
echo 'Изображение заголовка не установлено.';
}
Пример с тегом <img> для вывода изображения заголовка:
if ( get_header_image() ) {
?>
<img src="<?php echo esc_url( get_header_image() ); ?>" alt="<?php echo esc_attr( get_bloginfo( 'name' ) ); ?>" width="<?php echo get_custom_header()->width; ?>" height="<?php echo get_custom_header()->height; ?>">
<?php
}
Использование функции the_custom_header_markup()
Вместо самостоятельного формирования тега <img>, можно воспользоваться функцией the_custom_header_markup(), которая также добавит необходимые параметры для видео и адаптивных изображений.
the_custom_header_markup();Заключение
Функция get_header_image() является полезным инструментом для разработчиков тем в WordPress, позволяя динамически выводить URL изображения заголовка, которое установлено в настройках темы. Она помогает гибко работать с заголовками, добавляя изображения в шапку сайта при условии, что эта функция поддерживается темой. Для более продвинутой работы с изображениями и видео заголовков рекомендуется использовать функции, такие как the_custom_header_markup() или get_header_image_tag() для обеспечения адаптивности и включения всех необходимых атрибутов для современных экранов.