get_custom_header_markup(): string
- Since
- 4.7.0
- Source
wp-includes/theme.php:1801
Description
The container div will always be returned in the Customizer preview.
Compatibility
- WordPress
- since 4.7.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Return value
string- The markup for a custom header on success.
Performance profile
How much work a call to get_custom_header_markup() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 7–12
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 13.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below get_custom_header_markup()
Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_custom_header_markup() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!has_custom_header() && !is_customize_preview() | 7 | has_custom_header(), is_customize_preview() |
has_custom_header() | 9 | has_custom_header(), get_header_image_tag() |
!has_custom_header() && is_customize_preview() | 12 | has_custom_header(), is_customize_preview(), get_header_image_tag() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 13 | 7–12 | 2 | |
| 8.5 | 13 | 7–12 | 2 | |
| 8.4 | 13 | 7–12 | 2 | 1 fewer instruction than PHP 8.3 |
| 8.3 | 14 | 7–13 | 2 | |
| 8.2 | 14 | 7–13 | 2 | |
| 8.1 | 14 | 7–13 | 2 | |
| 7.4 | 14 | 7–13 | 2 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
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 code
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
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 7.1.0 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.