apply_filters( 'wp_get_attachment_image', string $html , int $attachment_id , string|int[] $size , bool $icon , string[] $attr )
Filters the HTML img element representing an image attachment.
Parameters
-
$html
string -
HTML img element or empty string on failure.
-
$attachment_id
int -
Image attachment ID.
-
$size
string|int[] -
Requested image size. Can be any registered image size name, or an array of width and height values in pixels (in that order).
-
$icon
bool -
Whether the image should be treated as an icon.
-
$attr
string[] -
Array of attribute values for the image markup, keyed by attribute name.
See wp_get_attachment_image() .More Arguments from wp_get_attachment_image( ... $attr )
Attributes for the image markup.
src
stringImage attachment URL.class
stringCSS class name or space-separated list of classes.
Defaultattachment-$size_class size-$size_class
, where$size_class
is the image size being requested.alt
stringImage description for the alt attribute.srcset
stringThe'srcset'
attribute value.sizes
stringThe'sizes'
attribute value.loading
string|falseThe'loading'
attribute value. Passing a value of false will result in the attribute being omitted for the image.
Defaults to'lazy'
, depending on wp_lazy_loading_enabled() .decoding
stringThe'decoding'
attribute value. Possible values are'async'
(default),'sync'
, or'auto'
. Passing false or an empty string will result in the attribute being omitted.
Source
File: wp-includes/media.php
.
View all references
return apply_filters( 'wp_get_attachment_image', $html, $attachment_id, $size, $icon, $attr );
Changelog
Version | Description |
---|---|
5.6.0 | Introduced. |