wpseek.com
A WordPress-centric search engine for devs and theme authors



file_is_displayable_image › WordPress Function

Since2.5.0
Deprecatedn/a
file_is_displayable_image ( $path )
Parameters:
  • (string) $path File path to test.
    Required: Yes
Returns:
  • (bool) True if suitable, false if not suitable.
Defined at:
Codex:

Validates that file is suitable for displaying within a web page.



Source

function file_is_displayable_image( $path ) {
	$displayable_image_types = array( IMAGETYPE_GIF, IMAGETYPE_JPEG, IMAGETYPE_PNG, IMAGETYPE_BMP, IMAGETYPE_ICO, IMAGETYPE_WEBP, IMAGETYPE_AVIF );

	$info = wp_getimagesize( $path );
	if ( empty( $info ) ) {
		$result = false;
	} elseif ( ! in_array( $info[2], $displayable_image_types, true ) ) {
		$result = false;
	} else {
		$result = true;
	}

	/**
	 * Filters whether the current image is displayable in the browser.
	 *
	 * @since 2.5.0
	 *
	 * @param bool   $result Whether the image can be displayed. Default true.
	 * @param string $path   Path to the image.
	 */
	return apply_filters( 'file_is_displayable_image', $result, $path );
}