file_is_displayable_image

Filters whether the current image is displayable in the browser.

Description

apply_filters( 'file_is_displayable_image', (bool) $result, (string) $path ); 

Parameters (2)

0. $result (bool)
Whether the image can be displayed. Default true.
1. $path (string)
Path to the image.

Usage

To run the hook, copy the example below.
  1. $result = apply_filters( 'file_is_displayable_image', $result, $path ); 
  2.  
  3. if ( !empty( $result ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the file_is_displayable_image callback 
  2. function filter_file_is_displayable_image( $result, $path ) { 
  3. // make filter magic happen here... 
  4. return $result
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'file_is_displayable_image', 'filter_file_is_displayable_image', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'file_is_displayable_image', 'filter_file_is_displayable_image', 10, 2 ); 

Defined (1)

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

/wp-admin/includes/image.php  
  1. return apply_filters( 'file_is_displayable_image', $result, $path );