get_image_send_to_editor( int $id, string $caption, string $title, string $align, string $url = '', bool|string $rel = false, string|int[] $size = 'medium', string $alt = '' ): string

Compatibility

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

Parameters

$idint

Image attachment ID.

$captionstring

Image caption.

$titlestring

Image title attribute.

$alignstring

Image CSS alignment property.

$urlstringoptional

Image src URL. Default empty.Default: ''

$relbool|stringoptional

Value for rel attribute or whether to add a default value. Default false.Default: false

$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 'medium'.Default: 'medium'

$altstringoptional

Image alt attribute. Default empty.Default: ''

Return value

string

The HTML output to insert into the editor.

Performance profile

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

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

33–51

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

Plugin surface

1 hook

Third-party callbacks on 'image_send_to_editor' 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

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

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( image_send_to_editor )filterline 168 (+35 into the body)

   Filters the image HTML markup to send to the editor when inserting an image.

Uses · 4

• get_image_tag()Gets an img tag for an image attachment, scaling it down if requested.
• esc_attr()Escaping for HTML attributes.
• esc_url()Checks and cleans a URL.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• image_media_send_to_editor()Retrieves the media element HTML to send to the editor.
• wp_ajax_send_attachment_to_editor()Handles sending an attachment to the editor via AJAX.

Source code

View on Trac ↗View on GitHub ↗

133function get_image_send_to_editor( $id, $caption, $title, $align, $url = '', $rel = false, $size = 'medium', $alt = '' ) {134 135	$html = get_image_tag( $id, $alt, '', $align, $size );136 137	if ( $rel ) {138		if ( is_string( $rel ) ) {139			$rel = ' rel="' . esc_attr( $rel ) . '"';140		} else {141			$rel = ' rel="attachment wp-att-' . (int) $id . '"';142		}143	} else {144		$rel = '';145	}146 147	if ( $url ) {148		$html = '<a href="' . esc_url( $url ) . '"' . $rel . '>' . $html . '</a>';149	}150 151	/**152	 * Filters the image HTML markup to send to the editor when inserting an image.153	 *154	 * @since 2.5.0155	 * @since 5.6.0 The `$rel` parameter was added.156	 *157	 * @param string       $html    The image HTML markup to send.158	 * @param int          $id      The attachment ID.159	 * @param string       $caption The image caption.160	 * @param string       $title   The image title.161	 * @param string       $align   The image alignment.162	 * @param string       $url     The image source URL.163	 * @param string|int[] $size    Requested image size. Can be any registered image size name, or164	 *                              an array of width and height values in pixels (in that order).165	 * @param string       $alt     The image alternative, or alt, text.166	 * @param string       $rel     The image rel attribute.167	 */168	$html = apply_filters( 'image_send_to_editor', $html, $id, $caption, $title, $align, $url, $size, $alt, $rel );169 170	return $html;171}

Changelog

Introduced in 2.5.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/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.