load_image_to_edit_path

Filters the returned path or URL of the current image.

Description

apply_filters( 'load_image_to_edit_path', (string|bool) $filepath, (string) $attachment_id, (string) $size ); 

Parameters (3)

0. $filepath (string|bool)
File path or URL to current image, or false.
1. $attachment_id (string)
The attachment id.
2. $size (string)
Size of the image.

Usage

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

Defined (1)

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

/wp-admin/includes/image.php  
  1. return apply_filters( 'load_image_to_edit_path', $filepath, $attachment_id, $size );