W3cubDocs

/WordPress

get_custom_header_markup()

Retrieve 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

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

Changelog

Version Description
4.7.0 Introduced.

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