file_is_displayable_image

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

Description

file_is_displayable_image( (string) $path ); 

Parameters (1)

0. $path (string)
File path to test.

Usage

  1. if ( !function_exists( 'file_is_displayable_image' ) ) { 
  2.     require_once ABSPATH . '/wp-admin/includes/image.php'; 
  3. } 
  4.   
  5. // File path to test. 
  6. $path = ''; 
  7.   
  8. // NOTICE! Understand what this does before running. 
  9. $result = file_is_displayable_image($path); 
  10.     

Defined (1)

The function is defined in the following location(s).

/wp-admin/includes/image.php  
  1. function file_is_displayable_image($path) { 
  2.     $displayable_image_types = array( IMAGETYPE_GIF, IMAGETYPE_JPEG, IMAGETYPE_PNG, IMAGETYPE_BMP ); 
  3.  
  4.     $info = @getimagesize( $path ); 
  5.     if ( empty( $info ) ) { 
  6.         $result = false; 
  7.     } elseif ( ! in_array( $info[2], $displayable_image_types ) ) { 
  8.         $result = false; 
  9.     } else { 
  10.         $result = true; 
  11.     } 
  12.  
  13.     /** 
  14.      * Filters whether the current image is displayable in the browser. 
  15.      * 
  16.      * @since 2.5.0 
  17.      * 
  18.      * @param bool   $result Whether the image can be displayed. Default true. 
  19.      * @param string $path   Path to the image. 
  20.      */ 
  21.     return apply_filters( 'file_is_displayable_image', $result, $path ); 
  22. }