load_image_to_edit filter-hookWP 2.9.0

Filters the current image being loaded for editing.

Usage

add_filter( 'load_image_to_edit', 'wp_kama_load_image_to_edit_filter', 10, 3 );

/**
 * Function for `load_image_to_edit` filter-hook.
 * 
 * @param resource|GdImage $image         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 resource|GdImage
 */
function wp_kama_load_image_to_edit_filter( $image, $attachment_id, $size ){

	// filter...
	return $image;
}
$image(resource|GdImage)
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 2.9.0 Introduced.

Where the hook is called

load_image_to_edit()
load_image_to_edit
wp-admin/includes/image.php 1043
$image = apply_filters( 'load_image_to_edit', $image, $attachment_id, $size );

Where the hook is used in WordPress

Usage not found.