get_image_send_to_editor()
最后更新于:2021-11-26 09:13:32
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=”)Retrieves the image HTML to send to the editor.
参数
- $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 value: ”
- $rel
-
(bool|string) (Optional) Value for rel attribute or whether to add a default value.
Default value: 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 value: ‘medium’
- $alt
-
(string) (Optional) Image alt attribute.
Default value: ”
响应
(string) The HTML output to insert into the editor.
源文件
文件: gc-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 gc-att-' . (int) $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 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;
}