wpseek.com
A WordPress-centric search engine for devs and theme authors



get_image_send_to_editor › WordPress Function

Since2.5.0
Deprecatedn/a
› get_image_send_to_editor ( $id, $caption, $title, $align, $url = '', $rel = false, $size = 'medium', $alt = '' )
Parameters: (8)
  • (int) $id Image attachment ID.
    Required: Yes
  • (string) $caption Image caption.
    Required: Yes
  • (string) $title Image title attribute.
    Required: Yes
  • (string) $align Image CSS alignment property.
    Required: Yes
  • (string) $url Optional. Image src URL. Default empty.
    Required: No
    Default: (empty)
  • (bool|string) $rel Optional. Value for rel attribute or whether to add a default value. Default false.
    Required: No
    Default: false
  • (string|int[]) $size Optional. Image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order). Default 'medium'.
    Required: No
    Default: 'medium'
  • (string) $alt Optional. Image alt attribute. Default empty.
    Required: No
    Default: (empty)
Returns:
  • (string) The HTML output to insert into the editor.
Defined at:
Codex:

Retrieves the image HTML to send to the editor.



Related Functions: image_media_send_to_editor, media_send_to_editor, get_tags_to_edit, wp_get_image_editor, get_link_to_edit

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