get_custom_header_markup(): string
- Since
- 4.7.0
- Source
wp-includes/theme.php:1808
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.
Uses · 3
- has_custom_header()Checks whether a custom header is set or not.
- is_customize_preview()Whether the site is being previewed in the Customizer.
- get_header_image_tag()Creates image tag markup for a custom header image.
Used by · 1
- the_custom_header_markup()Prints the markup for a custom header.
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() );}History
Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 tag, from
src/wp-includes/theme.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.