WordPress开发手册: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

函数描述

是否弃用

未弃用

函数参数

$id
int
Required

Image attachment ID.

$caption
string
Required

Image caption.

$title
string
Required

Image title attribute.

$align
string
Required

Image CSS alignment property.

$url
string
Optional

Image src URL.

Default: ''

$rel
bool|string
Optional

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

Default: false

$size
string|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'

$alt
string
Optional

Image alt attribute.

Default: ''

函数返回值

函数位置

函数源码

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

源码链接

WordPress
Github

变更日志