get_custom_header_markup() – Function

get_custom_header_markup(): string

Retrieves the markup for a custom header.

Description

The container div will always be returned in the Customizer preview.

Return

string The markup for a custom header on success.

Source

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

View all references View on Trac View on GitHub

Uses	Description
has_custom_header()`wp-includes/theme.php`	Checks whether a custom header is set or not.
get_header_image_tag()`wp-includes/theme.php`	Creates image tag markup for a custom header image.
is_customize_preview()`wp-includes/theme.php`	Whether the site is being previewed in the Customizer.

Used by	Description
the_custom_header_markup()`wp-includes/theme.php`	Prints the markup for a custom header.

Changelog

Version	Description
4.7.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.