WP_Theme::get_screenshot( string $uri = ‘uri’ ): string|false

Returns the main screenshot file for the theme.

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

Parameters

$uristringoptional
Type of URL to return, either 'relative' or an absolute URI. Defaults to absolute URI.

Default:'uri'

Return

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

Source

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

VersionDescription
3.4.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.