load_image_to_edit( int $attachment_id, string $mime_type, string|int[] $size = 'full' ): resource|GdImage|false

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$attachment_idint

Attachment ID.

$mime_typestring

Image mime type.

$sizestring|int[]optional

Image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order). Default 'full'.Default: 'full'

Return value

resource|GdImage|false

The resulting image resource or GdImage instance on success, false on failure.

Performance profile

How much work a call to load_image_to_edit() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

11–57

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 75.

Plugin surface

1 hook

Third-party callbacks on 'load_image_to_edit' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 25 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost load_image_to_edit() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while load_image_to_edit() runs, in this order:

1. 1
   apply_filters( load_image_to_edit )filterline 1171 (+38 into the body)

   Filters the current image being loaded for editing.

Uses · 3

• _load_image_to_edit_path()Retrieves the path or URL of an attachment's attached file.
• is_gd_image()Determines whether the value is an acceptable type for GD image functions.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Source code

View on Trac ↗View on GitHub ↗

1133function load_image_to_edit( $attachment_id, $mime_type, $size = 'full' ) {1134	$filepath = _load_image_to_edit_path( $attachment_id, $size );1135	if ( empty( $filepath ) ) {1136		return false;1137	}1138 1139	switch ( $mime_type ) {1140		case 'image/jpeg':1141			$image = imagecreatefromjpeg( $filepath );1142			break;1143		case 'image/png':1144			$image = imagecreatefrompng( $filepath );1145			break;1146		case 'image/gif':1147			$image = imagecreatefromgif( $filepath );1148			break;1149		case 'image/webp':1150			$image = false;1151			if ( function_exists( 'imagecreatefromwebp' ) ) {1152				$image = imagecreatefromwebp( $filepath );1153			}1154			break;1155		default:1156			$image = false;1157			break;1158	}1159 1160	if ( is_gd_image( $image ) ) {1161		/**1162		 * Filters the current image being loaded for editing.1163		 *1164		 * @since 2.9.01165		 *1166		 * @param resource|GdImage $image         Current image.1167		 * @param int              $attachment_id Attachment ID.1168		 * @param string|int[]     $size          Requested image size. Can be any registered image size name, or1169		 *                                        an array of width and height values in pixels (in that order).1170		 */1171		$image = apply_filters( 'load_image_to_edit', $image, $attachment_id, $size );1172 1173		if ( function_exists( 'imagealphablending' ) && function_exists( 'imagesavealpha' ) ) {1174			imagealphablending( $image, false );1175			imagesavealpha( $image, true );1176		}1177	}1178 1179	return $image;1180}

Changelog

Introduced in 2.9.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-admin/includes/image.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.