WP_Theme::get_screenshot( string $uri = 'uri' ): string|false
- Since
- 3.4.0
- Source
wp-includes/class-wp-theme.php:1270
Description
The main screenshot is called screenshot.png. gif and jpg extensions are also allowed.
Screenshots for a theme must be in the stylesheet directory. (In the case of child themes, parent theme screenshots are not inherited.)
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
$uristringoptional- Type of URL to return, either 'relative' or an absolute URI. Defaults to absolute URI.Default:
'uri'
Return value
string|false- Screenshot file. False if the theme does not have a screenshot.
Performance profile
How much work a call to WP_Theme::get_screenshot() 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
- Heavy
- Scaling
- Scales with input
- Instructions
- 9–31
- Plugin surface
- None
- Called by
- 2
Reads or writes the filesystem via file_exists().
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 49.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- filesystemfilesystem access
file_exists()called directly
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 WP_Theme::get_screenshot() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 9 | ->cache_get() |
$uri !== "relative" | 13 | ->cache_get(), ->get_stylesheet_directory_uri() |
$screenshot !== 0 | 15–16 | ->cache_get(), ->cache_add() |
$screenshot !== 0 && file_exists() && $uri === "relative" | 28 | ->cache_get(), ->get_stylesheet_directory(), file_exists(), ->cache_add() |
$screenshot !== 0 && file_exists() && $uri !== "relative" | 31 | ->cache_get(), ->get_stylesheet_directory(), file_exists(), ->cache_add(), ->get_stylesheet_directory_uri() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 49 instructions, 9–31 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 · 4
- WP_Theme::cache_get()Gets theme data from cache.
- WP_Theme::get_stylesheet_directory_uri()Returns the URL to the directory of a theme's "stylesheet" files.
- WP_Theme::get_stylesheet_directory()Returns the absolute path to the directory of a theme's "stylesheet" files.
- WP_Theme::cache_add()Adds theme data to cache.
Used by · 2
- WP_Theme::__get()__get() magic method for properties formerly returned by current_theme_info()
- WP_Theme::offsetGet()Method to implement ArrayAccess for keys formerly returned by get_themes().
Source code
public function get_screenshot( $uri = 'uri' ) { $screenshot = $this->cache_get( 'screenshot' ); if ( $screenshot ) { if ( 'relative' === $uri ) { return $screenshot; } return $this->get_stylesheet_directory_uri() . '/' . $screenshot; } elseif ( 0 === $screenshot ) { return false; } foreach ( array( 'png', 'gif', 'jpg', 'jpeg', 'webp', 'avif' ) as $ext ) { if ( file_exists( $this->get_stylesheet_directory() . "/screenshot.$ext" ) ) { $this->cache_add( 'screenshot', 'screenshot.' . $ext ); if ( 'relative' === $uri ) { return 'screenshot.' . $ext; } return $this->get_stylesheet_directory_uri() . '/' . 'screenshot.' . $ext; } } $this->cache_add( 'screenshot', 0 ); return false; }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.1.0 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.