load_image_to_edit_filesystempath filter-hookWP 3.1.0

Filters the path to an attachment's file when editing the image.

The filter is evaluated for all image sizes except 'full'.

Usage

add_filter( 'load_image_to_edit_filesystempath', 'wp_kama_load_image_to_edit_filesystempath_filter', 10, 3 );

/**
 * Function for `load_image_to_edit_filesystempath` filter-hook.
 * 
 * @param string       $path          Path to the current image.
 * @param int          $attachment_id Attachment ID.
 * @param string|int[] $size          Requested image size. Can be any registered image size name, or an array of width and height values in pixels (in that order).
 *
 * @return string
 */
function wp_kama_load_image_to_edit_filesystempath_filter( $path, $attachment_id, $size ){

	// filter...
	return $path;
}
$path(string)
Path to the current image.
$attachment_id(int)
Attachment ID.
$size(string|int[])
Requested image size. Can be any registered image size name, or an array of width and height values in pixels (in that order).

Changelog

Since 3.1.0 Introduced.

Where the hook is called

_load_image_to_edit_path()
load_image_to_edit_filesystempath
wp-admin/includes/image.php 1090
$filepath = apply_filters( 'load_image_to_edit_filesystempath', $filepath, $attachment_id, $size );

Where the hook is used in WordPress

Usage not found.