get_custom_header(): object
- Since
- 3.4.0
- Source
wp-includes/theme.php:1567
Compatibility
- WordPress
- since 3.4.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
object
Performance profile
How much work a call to get_custom_header() 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
- Light
- Scaling
- Scales with input
- Instructions
- 32–84
- Plugin surface
- None
- Called by
- 8
Touches nothing outside its own arguments.
The body loops, so the work grows with how much data it finds.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 88.
Nothing here hands control to plugin code.
8 places 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()
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 · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_custom_header() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_random_header_image() | 32 | is_random_header_image(), _get_random_header_data(), get_theme_support(), get_theme_support(), get_theme_support(), wp_parse_args() |
!is_random_header_image() | 33 | is_random_header_image(), get_theme_mod(), get_theme_support(), get_theme_support(), get_theme_support(), wp_parse_args() |
!is_random_header_image() && !current_theme_supports() | 38 | is_random_header_image(), get_theme_mod(), current_theme_supports(), get_theme_support(), get_theme_support(), get_theme_support(), wp_parse_args() |
!is_random_header_image() && current_theme_supports() | 61–65 | is_random_header_image(), get_theme_mod(), current_theme_supports(), get_template_directory_uri(), get_stylesheet_directory_uri(), get_theme_support(), vsprintf(), get_theme_support(), get_theme_support(), get_theme_support(), wp_parse_args() |
!is_random_header_image() && current_theme_supports() && !empty($_wp_default_headers) && !$_wp_default_headers && $url === false | 84 | is_random_header_image(), get_theme_mod(), current_theme_supports(), get_template_directory_uri(), get_stylesheet_directory_uri(), get_theme_support(), vsprintf(), vsprintf(), vsprintf(), get_theme_support(), get_theme_support(), get_theme_support(), wp_parse_args() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 88 instructions, 32–84 executed per call, 7 branches. The work does not change between versions.
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 · 8
- is_random_header_image()Checks if random header image is in use.
- _get_random_header_data()Gets random header image data from registered images in theme.
- get_theme_mod()Retrieves theme modification value for the active theme.
- current_theme_supports()Checks a theme's support for a given feature.
- get_template_directory_uri()Retrieves template directory URI for the active theme.
- get_stylesheet_directory_uri()Retrieves stylesheet directory URI for the active theme.
- get_theme_support()Gets the theme support arguments passed when registering that support.
- wp_parse_args()Merges user defined arguments into defaults array.
Used by · 8
- Custom_Image_Header::step_1()Displays first step of custom header image page.
- get_header_image_tag()Creates image tag markup for a custom header image.
- get_header_video_settings()Retrieves header video settings.
- twentyeleven_header_image()Displays custom header image markup.
- twentyfourteen_header_image()Creates the custom header image markup displayed.
- twentyten_header_image()Displays the custom header image markup.
- twentytwelve_admin_header_image()Outputs markup to be displayed on the Appearance > Header admin panel.
- twentytwelve_header_image()Outputs markup to be displayed.
Source code
function get_custom_header() { global $_wp_default_headers; if ( is_random_header_image() ) { $data = _get_random_header_data(); } else { $data = get_theme_mod( 'header_image_data' ); if ( ! $data && current_theme_supports( 'custom-header', 'default-image' ) ) { $directory_args = array( get_template_directory_uri(), get_stylesheet_directory_uri() ); $data = array(); $data['url'] = vsprintf( get_theme_support( 'custom-header', 'default-image' ), $directory_args ); $data['thumbnail_url'] = $data['url']; if ( ! empty( $_wp_default_headers ) ) { foreach ( (array) $_wp_default_headers as $default_header ) { $url = vsprintf( $default_header['url'], $directory_args ); if ( $data['url'] === $url ) { $data = $default_header; $data['url'] = $url; $data['thumbnail_url'] = vsprintf( $data['thumbnail_url'], $directory_args ); break; } } } } } $default = array( 'url' => '', 'thumbnail_url' => '', 'width' => get_theme_support( 'custom-header', 'width' ), 'height' => get_theme_support( 'custom-header', 'height' ), 'video' => get_theme_support( 'custom-header', 'video' ), ); return (object) wp_parse_args( $data, $default );}Changelog
Introduced in 3.4.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.