W3cubDocs

/WordPress

the_custom_header_markup()

Prints the markup for a custom header.

Description

A container div will always be printed in the Customizer preview.

Source

File: wp-includes/theme.php 

function the_custom_header_markup() {
	$custom_header = get_custom_header_markup();
	if ( empty( $custom_header ) ) {
		return;
	}

	echo $custom_header;

	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() );
	}
}

Uses

Uses Description
wp-includes/theme.php: get_custom_header_markup()

Retrieves the markup for a custom header.
wp-includes/theme.php: is_header_video_active()

Checks whether the custom header video is eligible to show on the current page.
wp-includes/theme.php: has_header_video()

Checks whether a header video is set or not.
wp-includes/theme.php: get_header_video_settings()

Retrieves header video settings.
wp-includes/theme.php: is_customize_preview()

Whether the site is being previewed in the Customizer.
wp-includes/functions.wp-scripts.php: wp_enqueue_script()

Enqueue a script.
wp-includes/functions.wp-scripts.php: wp_localize_script()

Localize a script.

Changelog

Version Description
4.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/the_custom_header_markup