wppaste
WordPress

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

Since
2.5.0
Source
wp-admin/includes/media.php:133
Retrieves the image HTML to send to the editor.

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

string
The HTML output to insert into the editor.

Hooks fired · 1

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

  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

Used by · 2

Source

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-' . (int) $id . '"';		}	} else {		$rel = '';	} 	if ( $url ) {		$html = '<a href="' . esc_url( $url ) . '"' . $rel . '>' . $html . '</a>';	} 	/**	 * Filters the image HTML markup to send to the editor when inserting an image.	 *	 * @since 2.5.0	 * @since 5.6.0 The `$rel` parameter was added.	 *	 * @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|int[] $size    Requested image size. Can be any registered image size name, or	 *                              an array of width and height values in pixels (in that order).	 * @param string       $alt     The image alternative, or alt, text.	 * @param string       $rel     The image rel attribute.	 */	$html = apply_filters( 'image_send_to_editor', $html, $id, $caption, $title, $align, $url, $size, $alt, $rel ); 	return $html;}

History

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 7.0.4 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.