WP_Theme::get_screenshot │ public │ WP 3.4.0

Returns the main screenshot file for the theme.

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.)

Method of the class: WP_Theme{}

No Hooks.

Returns

String|false. Screenshot file. False if the theme does not have a screenshot.

Usage

$WP_Theme = new WP_Theme();
$WP_Theme->get_screenshot( $uri );

$uri(string)

Type of URL to return, either 'relative' or an absolute URI.
Default: absolute URI

Changelog

WP_Theme::get_screenshot() WP Theme::get screenshot code ^{WP 6.9.1}

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;
}