edit_form_image_editor( WP_Post $post )

Compatibility

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

Parameters

$postWP_Post

A post object.

Performance profile

How much work a call to edit_form_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

91–198

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

Plugin surface

2 hooks

Third-party callbacks on 'wp_edit_form_attachment_display', 'activate_tinymce_for_media_description' 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 callbacksdo_action()called directly
• querycontent queryget_post()one call below edit_form_image_editor()
• transienttransientget_transient()one call below edit_form_image_editor()

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

What one call costs · 120 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while edit_form_image_editor() runs, in this order:

1. 1
   do_action( wp_edit_form_attachment_display )actionline 3224 (+105 into the body)

   Fires when an attachment type can't be rendered in the edit form.

2. 2
   apply_filters( activate_tinymce_for_media_description )filterline 3275 (+156 into the body)

   Filters the TinyMCE argument for the media description field on the attachment details screen.

Uses · 25

• wp_get_attachment_image_src()Retrieves an image to represent an attachment.
• get_post_meta()Retrieves a post meta field for the given post ID.
• wp_get_attachment_url()Retrieves the URL for an attachment.
• wp_attachment_is_image()Determines whether an attachment is an image.
• wp_image_editor_supports()Tests whether there is an editor that supports a given mime type or methods.
• wp_create_nonce()Creates a cryptographic token tied to a specific action, user, user session, and window of time.
• esc_attr__()Retrieves the translation of $text and escapes it for safe use in an attribute.
• set_url_scheme()Sets the scheme for a URL.
• wp_image_editor()Loads the WP image-editing interface.
• wp_attachment_is()Verifies an attachment is of a given type.
• wp_maybe_generate_attachment_metadata()Maybe attempts to generate attachment metadata, if missing.
• wp_audio_shortcode()Builds the Audio shortcode output.

Source code

View on Trac ↗View on GitHub ↗

3119function edit_form_image_editor( $post ) {3120	$open = isset( $_GET['image-editor'] );3121 3122	if ( $open ) {3123		require_once ABSPATH . 'wp-admin/includes/image-edit.php';3124	}3125 3126	$thumb_url     = false;3127	$attachment_id = (int) $post->ID;3128 3129	if ( $attachment_id ) {3130		$thumb_url = wp_get_attachment_image_src( $attachment_id, array( 900, 450 ), true );3131	}3132 3133	$alt_text = get_post_meta( $post->ID, '_wp_attachment_image_alt', true );3134 3135	$att_url = wp_get_attachment_url( $post->ID );3136	?>3137	<div class="wp_attachment_holder wp-clearfix">3138	<?php3139 3140	if ( wp_attachment_is_image( $post->ID ) ) :3141		$image_edit_button = '';3142		if ( wp_image_editor_supports( array( 'mime_type' => $post->post_mime_type ) ) ) {3143			$nonce             = wp_create_nonce( "image_editor-$post->ID" );3144			$image_edit_button = "<input type='button' id='imgedit-open-btn-$post->ID' onclick='imageEdit.open( $post->ID, \"$nonce\" )' class='button' value='" . esc_attr__( 'Edit Image' ) . "' /> <span class='spinner'></span>";3145		}3146 3147		$open_style     = '';3148		$not_open_style = '';3149 3150		if ( $open ) {3151			$open_style = ' style="display:none"';3152		} else {3153			$not_open_style = ' style="display:none"';3154		}3155 3156		?>3157		<div class="imgedit-response" id="imgedit-response-<?php echo $attachment_id; ?>"></div>3158 3159		<div<?php echo $open_style; ?> class="wp_attachment_image wp-clearfix" id="media-head-<?php echo $attachment_id; ?>">3160			<p id="thumbnail-head-<?php echo $attachment_id; ?>"><img class="thumbnail" src="<?php echo set_url_scheme( $thumb_url[0] ); ?>" style="max-width:100%" alt="" /></p>3161			<p><?php echo $image_edit_button; ?></p>3162		</div>3163		<div<?php echo $not_open_style; ?> class="image-editor" id="image-editor-<?php echo $attachment_id; ?>">3164		<?php3165 3166		if ( $open ) {3167			wp_image_editor( $attachment_id );3168		}3169 3170		?>3171		</div>3172		<?php3173	elseif ( $attachment_id && wp_attachment_is( 'audio', $post ) ) :3174 3175		wp_maybe_generate_attachment_metadata( $post );3176 3177		echo wp_audio_shortcode( array( 'src' => $att_url ) );3178 3179	elseif ( $attachment_id && wp_attachment_is( 'video', $post ) ) :3180 3181		wp_maybe_generate_attachment_metadata( $post );3182 3183		$meta = wp_get_attachment_metadata( $attachment_id );3184		$w    = ! empty( $meta['width'] ) ? min( $meta['width'], 640 ) : 0;3185		$h    = ! empty( $meta['height'] ) ? $meta['height'] : 0;3186 3187		if ( $h && $w < $meta['width'] ) {3188			$h = round( ( $meta['height'] * $w ) / $meta['width'] );3189		}3190 3191		$attr = array( 'src' => $att_url );3192 3193		if ( ! empty( $w ) && ! empty( $h ) ) {3194			$attr['width']  = $w;3195			$attr['height'] = $h;3196		}3197 3198		$thumb_id = get_post_thumbnail_id( $attachment_id );

Changelog

Introduced in 3.5.0. Unchanged from 6.7.10 through 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

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

About this page

Parsed data

Generated from the wordpress-develop 6.9.10 tag, from src/wp-admin/includes/media.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.