WP_Theme::get( string $header ): string|array|false
- Since
- 3.4.0
- Source
wp-includes/class-wp-theme.php:878
Description
The header is sanitized, but is not translated, and is not marked up for display.
To get a theme header for display, use the display() method.
Use the get_template() method, not the 'Template' header, for finding the template.
The 'Template' header is only good for what was written in the style.css, while get_template() takes into account where WordPress actually located the theme and whether it is actually valid.
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.
Parameters
$headerstring- Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
Return value
string|array|false- String or array (for Tags header) on success, false on failure.
Performance profile
How much work a call to WP_Theme::get() 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
- 5–38
- Plugin surface
- None
- Called by
- 8
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 63.
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 one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Theme::get() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 5–12 | none |
isset($header) && !isset($value) | 20–22 | ->cache_get() |
isset($value) | 24 | ->sanitize_header() |
isset($value) | 27–28 | array_keys(), ->cache_add() |
!isset($value) | 32–34 | ->cache_get(), ->sanitize_header() |
!isset($value) | 35–38 | ->cache_get(), array_keys(), ->cache_add() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 63 instructions, 5–38 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 · 3
- WP_Theme::cache_get()Gets theme data from cache.
- WP_Theme::sanitize_header()Sanitizes a theme header.
- WP_Theme::cache_add()Adds theme data to cache.
Used by · 8
- WP_Theme::__get()__get() magic method for properties formerly returned by current_theme_info()
- WP_Theme::display()Gets a theme header, formatted and translated for display.
- WP_Theme::get_pattern_cache()Gets block pattern cache.
- WP_Theme::load_textdomain()Loads the theme's textdomain.
- WP_Theme::markup_header()Marks up a theme header.
- WP_Theme::offsetGet()Method to implement ArrayAccess for keys formerly returned by get_themes().
- WP_Theme::set_pattern_cache()Sets block pattern cache.
- WP_Theme::translate_header()Translates a theme header.
Source code
public function get( $header ) { if ( ! isset( $this->headers[ $header ] ) ) { return false; } if ( ! isset( $this->headers_sanitized ) ) { $this->headers_sanitized = $this->cache_get( 'headers' ); if ( ! is_array( $this->headers_sanitized ) ) { $this->headers_sanitized = array(); } } if ( isset( $this->headers_sanitized[ $header ] ) ) { return $this->headers_sanitized[ $header ]; } // If themes are a persistent group, sanitize everything and cache it. One cache add is better than many cache sets. if ( self::$persistently_cache ) { foreach ( array_keys( $this->headers ) as $_header ) { $this->headers_sanitized[ $_header ] = $this->sanitize_header( $_header, $this->headers[ $_header ] ); } $this->cache_add( 'headers', $this->headers_sanitized ); } else { $this->headers_sanitized[ $header ] = $this->sanitize_header( $header, $this->headers[ $header ] ); } return $this->headers_sanitized[ $header ]; }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 7.0.4 tag, from
src/wp-includes/class-wp-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.