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

Retrieves the image HTML to send to the editor.

Parameters

$id

(Required) Image attachment id.

$caption

(Required) Image caption.

$title

(Required) Image title attribute.

$align

(Required) Image CSS alignment property.

$url

(Optional) Image src URL.

Default value: ''

$rel

(Optional) Value for rel attribute or whether to add a default value.

Default value: false

$size

(Optional) Image size. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'medium'.

Default value: 'medium'

$alt

(Optional) Image alt attribute.

Default value: ''

Return

(string) The HTML output to insert into the editor.

Source

File: wp-admin/includes/media.php 

function get_image_send_to_editor( $id, $caption, $title, $align, $url = '', $rel = false, $size = 'medium', $alt = '' ) {

	$html = get_image_tag( $id, $alt, '', $align, $size );

	if ( $rel ) {
		if ( is_string( $rel ) ) {
			$rel = ' rel="' . esc_attr( $rel ) . '"';
		} else {
			$rel = ' rel="attachment wp-att-' . intval( $id ) . '"';
		}
	} else {
		$rel = '';
	}

	if ( $url )
		$html = '<a href="' . esc_attr( $url ) . '"' . $rel . '>' . $html . '</a>';

	/**
	 * Filters the image HTML markup to send to the editor when inserting an image.
	 *
	 * @since WP-2.5.0
	 *
	 * @param string       $html    The image HTML markup to send.
	 * @param int          $id      The attachment id.
	 * @param string       $caption The image caption.
	 * @param string       $title   The image title.
	 * @param string       $align   The image alignment.
	 * @param string       $url     The image source URL.
	 * @param string|array $size    Size of image. Image size or array of width and height values
	 *                              (in that order). Default 'medium'.
	 * @param string       $alt     The image alternative, or alt, text.
	 */
	$html = apply_filters( 'image_send_to_editor', $html, $id, $caption, $title, $align, $url, $size, $alt );

	return $html;
}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/media.php: get_image_tag()

Gets an img tag for an image attachment, scaling it down if requested.
wp-includes/plugin.php: apply_filters()

Call the functions added to a filter hook.
wp-includes/formatting.php: esc_attr()

Escaping for HTML attributes.
wp-admin/includes/media.php: image_send_to_editor

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

Changelog

Changelog
Version Description
WP-2.5.0 Introduced.