WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_image_send_to_editor()

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

In this article

Back to top

Retrieves the image HTML to send to the editor.

Parameters

$idintrequired
Image attachment ID.
$captionstringrequired
Image caption.
$titlestringrequired
Image title attribute.
$alignstringrequired
Image CSS alignment property.
$urlstringoptional
Image src URL.

Default:''

$relbool|stringoptional
Value for rel attribute or whether to add a default value.

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:''

Return

string The HTML output to insert into the editor.

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;
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘image_send_to_editor’, string $html, int $id, string $caption, string $title, string $align, string $url, string|int[] $size, string $alt, string $rel )

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

UsesDescription
get_image_tag()wp-includes/media.php

Gets an img tag for an image attachment, scaling it down if requested.

esc_attr()wp-includes/formatting.php

Escaping for HTML attributes.

esc_url()wp-includes/formatting.php

Checks and cleans a URL.

apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Show 2 moreShow less
Used byDescription
image_media_send_to_editor()wp-admin/includes/media.php

Retrieves the media element HTML to send to the editor.

wp_ajax_send_attachment_to_editor()wp-admin/includes/ajax-actions.php

Handles sending an attachment to the editor via AJAX.

Changelog

VersionDescription
2.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.