get_custom_header_markup() │ WP 4.7.0

Получает HTML разметку для заголовка шапки. Там могут быть картинки и видео.

В кастомайзере <div> в котором должен быть заголовок выводиться всегда независимо от того установлен заголовок для темы или нет.

Функция выводит HTML картинки, если она есть обернутой в <div id="wp-custom-header" class="wp-custom-header">.

Чтобы показать видео заголовка, если оно есть и должно отображаться на текущей странице, нужно подключить скрипт:

if( is_header_video_active() && ( has_header_video() || is_customize_preview() ) ){
	wp_enqueue_script( 'wp-custom-header' );
}

Используйте the_custom_header_markup(), чтобы сразу вывести HTML на экран и подключить нужные скрипты видео, если видео доступно на странице.

Работает на основе: get_header_image_tag()
Основа для: the_custom_header_markup()

Хуков нет.

Возвращает

Строку. HTML код картинки заголовка.

Использование

$html = get_custom_header_markup();

Примеры

0

#1 Выведем HTML код заголовка шапки

Этот код выведет картинку шапки.

// функция сама проверяет есть ли заголовок для шапки - has_custom_header()
echo get_custom_header_markup();

// Если есть видео шапки и оно работает для для текущей страницы подключим скрипт чтобы показать видео.
if ( is_header_video_active() && ( has_header_video() || is_customize_preview() ) ) {
	wp_enqueue_script( 'wp-custom-header' );
	wp_localize_script( 'wp-custom-header', '_wpCustomHeaderSettings', get_header_video_settings() );
}

В результате получим след. HTML код:

<div id="wp-custom-header" class="wp-custom-header">
	<img src="http://example.com/wp-content/uploads/2016/05/cropped.jpg" width="954" height="1300" alt="Тестовый сайт"
		 srcset="http://example.com/wp-content/uploads/2016/05/cropped.jpg 954w, http://example.com/wp-content/uploads/2016/05/cropped-220x300.jpg 220w, http://example.com/wp-content/uploads/2016/05/cropped-768x1047.jpg 768w, http://example.com/wp-content/uploads/2016/05/cropped-751x1024.jpg 751w"
		 sizes="(max-width: 954px) 100vw, 954px"
	/>
</div>

Список изменений

С версии 4.7.0 Введена.

Код get_custom_header_markup() WP 6.7.2

wp-includes/theme.php 
function get_custom_header_markup() {
	if ( ! has_custom_header() && ! is_customize_preview() ) {
		return '';
	}

	return sprintf(
		'<div id="wp-custom-header" class="wp-custom-header">%s</div>',
		get_header_image_tag()
	);
}

custom_header (настройки шапки темы: картинка цвет видео)

Другие функции темы