wp_image_editor( int $post_id, false|object $msg = 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

$post_idint

Attachment post ID.

$msgfalse|objectoptional

Message to display for image editor updates or errors.
Default false.Default: false

Performance profile

How much work a call to wp_image_editor() 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

Heavy

Reaches the database via get_post().

Scaling

Constant

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

Instructions

431–541

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

Plugin surface

1 hook

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

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()one call below wp_image_editor()

Further down the call graph this can also reach 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 · 6 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

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

1. 1
   apply_filters( image_edit_thumbnails_separately )filterline 55 (+37 into the body)

   Shows the settings in the Image Editor that allow selecting to edit only the thumbnail of an image.

Uses · 17

• wp_create_nonce()Creates a cryptographic token tied to a specific action, user, user session, and window of time.
• wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
• image_get_intermediate_size()Retrieves the image's intermediate size (resized) path, width, and height.
• __()Retrieves the translation of $text.
• get_post_meta()Retrieves a post meta field for the given post ID.
• wp_basename()i18n-friendly version of basename().
• apply_filters()Calls the callback functions that have been added to a filter hook.
• esc_html_e()Displays translated text that has been escaped for safe use in HTML output.
• esc_html_x()Translates string with gettext context, and escapes it for safe use in HTML output.
• wp_image_editor_supports()Tests whether there is an editor that supports a given mime type or methods.
• get_post_mime_type()Retrieves the mime type of an attachment based on the ID.
• esc_url()Checks and cleans a URL.

Used by · 2

• edit_form_image_editor()Displays the image and editor in the post editor
• wp_ajax_image_editor()Handles image editing via AJAX.

Source code

View on Trac ↗View on GitHub ↗

18function wp_image_editor( $post_id, $msg = false ) {19	$nonce     = wp_create_nonce( "image_editor-$post_id" );20	$meta      = wp_get_attachment_metadata( $post_id );21	$thumb     = image_get_intermediate_size( $post_id, 'thumbnail' );22	$sub_sizes = isset( $meta['sizes'] ) && is_array( $meta['sizes'] );23	$note      = '';24 25	if ( isset( $meta['width'], $meta['height'] ) ) {26		$big = max( $meta['width'], $meta['height'] );27	} else {28		die( __( 'Image data does not exist. Please re-upload the image.' ) );29	}30 31	$sizer = $big > 600 ? 600 / $big : 1;32 33	$backup_sizes = get_post_meta( $post_id, '_wp_attachment_backup_sizes', true );34	$can_restore  = false;35 36	if ( ! empty( $backup_sizes ) && isset( $backup_sizes['full-orig'], $meta['file'] ) ) {37		$can_restore = wp_basename( $meta['file'] ) !== $backup_sizes['full-orig']['file'];38	}39 40	if ( $msg ) {41		if ( isset( $msg->error ) ) {42			$note = "<div class='notice notice-error' role='alert'><p>$msg->error</p></div>";43		} elseif ( isset( $msg->msg ) ) {44			$note = "<div class='notice notice-success' role='alert'><p>$msg->msg</p></div>";45		}46	}47 48	/**49	 * Shows the settings in the Image Editor that allow selecting to edit only the thumbnail of an image.50	 *51	 * @since 6.3.052	 *53	 * @param bool $show Whether to show the settings in the Image Editor. Default false.54	 */55	$edit_thumbnails_separately = (bool) apply_filters( 'image_edit_thumbnails_separately', false );56 57	?>58	<div class="imgedit-wrap wp-clearfix">59	<div id="imgedit-panel-<?php echo $post_id; ?>">60	<?php echo $note; ?>61	<div class="imgedit-panel-content imgedit-panel-tools wp-clearfix">62		<div class="imgedit-menu wp-clearfix">63			<button type="button" onclick="imageEdit.toggleCropTool( <?php echo "$post_id, '$nonce'"; ?>, this );" aria-expanded="false" aria-controls="imgedit-crop" class="imgedit-crop button disabled" disabled><?php esc_html_e( 'Crop' ); ?></button>64			<button type="button" class="imgedit-scale button" onclick="imageEdit.toggleControls(this);" aria-expanded="false" aria-controls="imgedit-scale"><?php echo esc_html_x( 'Scale', 'verb' ); ?></button>65			<div class="imgedit-rotate-menu-container">66				<button type="button" aria-controls="imgedit-rotate-menu" class="imgedit-rotate button" aria-expanded="false" onclick="imageEdit.togglePopup(this)" onblur="imageEdit.monitorPopup()"><?php esc_html_e( 'Image Rotation' ); ?></button>67				<div id="imgedit-rotate-menu" class="imgedit-popup-menu">68			<?php69			// On some setups GD library does not provide imagerotate() - Ticket #11536.70			if ( wp_image_editor_supports(71				array(72					'mime_type' => get_post_mime_type( $post_id ),73					'methods'   => array( 'rotate' ),74				)75			) ) {76				$note_no_rotate = '';77				?>78					<button type="button" class="imgedit-rleft button" onkeydown="imageEdit.browsePopup(event, this)" onclick="imageEdit.rotate( 90, <?php echo "$post_id, '$nonce'"; ?>, this)" onblur="imageEdit.monitorPopup()"><?php esc_html_e( 'Rotate 90&deg; left' ); ?></button>79					<button type="button" class="imgedit-rright button" onkeydown="imageEdit.browsePopup(event, this)" onclick="imageEdit.rotate(-90, <?php echo "$post_id, '$nonce'"; ?>, this)" onblur="imageEdit.monitorPopup()"><?php esc_html_e( 'Rotate 90&deg; right' ); ?></button>80					<button type="button" class="imgedit-rfull button" onkeydown="imageEdit.browsePopup(event, this)" onclick="imageEdit.rotate(180, <?php echo "$post_id, '$nonce'"; ?>, this)" onblur="imageEdit.monitorPopup()"><?php esc_html_e( 'Rotate 180&deg;' ); ?></button>81				<?php82			} else {83				$note_no_rotate = '<p class="note-no-rotate"><em>' . __( 'Image rotation is not supported by your web host.' ) . '</em></p>';84				?>85					<button type="button" class="imgedit-rleft button disabled" disabled></button>86					<button type="button" class="imgedit-rright button disabled" disabled></button>87				<?php88			}89			?>90					<hr />91					<button type="button" onkeydown="imageEdit.browsePopup(event, this)" onclick="imageEdit.flip(1, <?php echo "$post_id, '$nonce'"; ?>, this)" onblur="imageEdit.monitorPopup()" class="imgedit-flipv button"><?php esc_html_e( 'Flip vertical' ); ?></button>92					<button type="button" onkeydown="imageEdit.browsePopup(event, this)" onclick="imageEdit.flip(2, <?php echo "$post_id, '$nonce'"; ?>, this)" onblur="imageEdit.monitorPopup()" class="imgedit-fliph button"><?php esc_html_e( 'Flip horizontal' ); ?></button>93					<?php echo $note_no_rotate; ?>94				</div>95			</div>96		</div>97		<div class="imgedit-submit imgedit-menu">

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 7.1.0 tag, from src/wp-admin/includes/image-edit.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.