display_header_text(): bool
- Since
- 3.4.0
- Source
wp-includes/theme.php:1191
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
bool
Performance profile
How much work a call to display_header_text() 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
- 6–16
- Plugin surface
- None
- Called by
- 10
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 17.
Nothing here hands control to plugin code.
10 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 display_header_text()
Further down the call graph this can also reach option, cache, serialize, transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost display_header_text() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!current_theme_supports() | 6 | current_theme_supports() |
current_theme_supports() | 16 | current_theme_supports(), get_theme_support(), get_theme_mod() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 17 instructions, 6–16 executed per call, 1 branch. 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 · 3
- current_theme_supports()Checks a theme's support for a given feature.
- get_theme_mod()Retrieves theme modification value for the active theme.
- get_theme_support()Gets the theme support arguments passed when registering that support.
Used by · 10
- Custom_Image_Header::js_1()Displays JavaScript based on Step 1 and 3.
- Custom_Image_Header::step_1()Displays first step of custom header image page.
- twentyfifteen_header_style()Styles the header image and text displayed on the blog.
- twentyfourteen_header_style()Styles the header image and text displayed on the blog
- twentysixteen_header_style()Styles the header text displayed on the site.
- twentythirteen_admin_header_image()Output markup to be displayed on the Appearance > Header admin panel.
- twentythirteen_admin_header_style()Style the header image displayed on the Appearance > Header admin panel.
- twentythirteen_header_style()Style the header text displayed on the blog.
- twentytwelve_admin_header_image()Output markup to be displayed on the Appearance > Header admin panel.
- twentytwelve_header_style()Style the header text displayed on the blog.
Source code
function display_header_text() { if ( ! current_theme_supports( 'custom-header', 'header-text' ) ) { return false; } $text_color = get_theme_mod( 'header_textcolor', get_theme_support( 'custom-header', 'default-text-color' ) ); return 'blank' !== $text_color;}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.7.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.