load_image_to_edit_path filter-hookWP 2.9.0

Filters the returned path or URL of the current image.

Usage

add_filter( 'load_image_to_edit_path', 'wp_kama_load_image_to_edit_path_filter', 10, 3 );

/**
 * Function for `load_image_to_edit_path` filter-hook.
 * 
 * @param string|false $filepath      File path or URL to current image, or false.
 * @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|false
 */
function wp_kama_load_image_to_edit_path_filter( $filepath, $attachment_id, $size ){

	// filter...
	return $filepath;
}
$filepath(string|false)
File path or URL to current image, or false.
$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 2.9.0 Introduced.

Where the hook is called

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

Where the hook is used in WordPress

Usage not found.