wp_get_attachment_image() │ WP 2.5.0
Получает <img> тег картинки указанного вложения (прикрепленного к посту файла).
Если вложение не удалось найти, то будет возвращена пустая строка.
Если вложение является картинкой, то для нее будет возвращен код, соответствующий указанному размеру (см. параметр $size).
Для прикрепленных файлов типа отличного от картинок (.zip, .xls, .flv) будет возвращена соответствующая этому типу иконка (автоматически определяется WordPress). По умолчанию такая иконка не выводится, чтобы она выводилась нужно выставить 3-й параметр ($icon) в true.
Возвращает
Строку
. HTML код картинки в <img> тега.
Использование
$img = wp_get_attachment_image( $attachment_id, $size, $icon, $attr );
$attachment_id(число) (обязательный)
ID вложения, картинку которого нужно получить.
$size(строка/массив)
Размер картинки. Можно указать в виде:
Строки thumbnail
, medium
, large
, full
или название имеющегося размера
В виде массива из 2-х элементов, определяющих размеры сторон выводимой картинки: array(32,32)
.
Указание размеров через массив не уменьшает картинку физически, она уменьшается только визуально из наиболее подходящей готовой миниатюры (uploads).
Указание размеров не влияет на размеры выводимых иконок для файлов, они всегда выводятся в оригинальном размере (32х32).
Вместо использования массива, иногда логично зарегистрировать новый размер картинок (add_image_size() ) и использовать его наряду с уже установленными (thumbnail
, medium
, large
или full
). Такой подход более эффективен, так как нет нужды постоянно проверять какой размер из имеющихся подходил лучше.
По умолчанию: "thumbnail"
$icon(логический)
Использовать ли медиа иконки, для представления вложения. По умолчанию, для вложений типа файл (не картинок), иконка выводится не будет, если нужно выводить иконки для таких типов вложений выставите этот параметр в true.
По умолчанию: false
$attr(массив)
Любые атрибуты для тега <img> в массиве. Например:
array(
'class' => 'foo bar',
'title' => 'название картинки',
'alt' => 'alt картинки',
'srcset' => '',
'sizes' => '',
)
alt по умолчанию берется из данных вложения:
'alt' => trim( strip_tags( get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ) ) )
Примеры
#1 Укажем атрибуты alt и title для картинки
$params = [ 'alt' => 'alt картинки', 'title' => 'название картинки' ]
$tag = wp_get_attachment_image( 15108, 'medium', false, $params );
Получим:
<img width="588" height="216"
src="/wp-content/uploads/2021/12/clipboard-image-122190.png"
class="attachment-medium size-medium"
alt="alt картинки"
loading="lazy"
title="название картинки" />
#2 Выведем готовую для HTML картинку
Выведем картинку <img> среднего размера медиа файла-картинки 651:
<?php echo wp_get_attachment_image( 651, 'medium'); ?>
Выведет примерно такой HTML:
<img width="250" height="250" src="http://example.com/image-250x250.png" class="attachment-medium size-medium" alt="Текст из поля Alt Text" />
alt текст будет заполнен, только если он указан для вложения в специальном поле (alt text). В alt не попадает текст из заголовка (title), описания (description) или подписи (caption) картинки...
#3 Пример с указанием произвольного размера
Выведем картинку указанного размера 20х20 пикселей, для вложений типа "картинка" и соответствующую иконку для остальных типов вложений (3-й параметр):
<?php echo wp_get_attachment_image( $post->ID, array(20,20), true); ?>
$post->ID
— динамическая передача ID внутри цикла. Создать такой цикл можно, использовав функцию get_posts() (get_posts('post_type=attachment')
).
Добавить свой пример
Список изменений
С версии 2.5.0
Введена.
С версии 4.4.0
The $srcset and $sizes attributes were added.
С версии 5.5.0
The $loading attribute was added.
С версии 6.1.0
The $decoding attribute was added.
Код wp_get_attachment_image() wp get attachment image
WP 6.7.1
function wp_get_attachment_image( $attachment_id, $size = 'thumbnail', $icon = false, $attr = '' ) {
$html = '';
$image = wp_get_attachment_image_src( $attachment_id, $size, $icon );
if ( $image ) {
list( $src, $width, $height ) = $image;
$attachment = get_post( $attachment_id );
$hwstring = image_hwstring( $width, $height );
$size_class = $size;
if ( is_array( $size_class ) ) {
$size_class = implode( 'x', $size_class );
}
$default_attr = array(
'src' => $src,
'class' => "attachment-$size_class size-$size_class",
'alt' => trim( strip_tags( get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ) ) ),
);
/**
* Filters the context in which wp_get_attachment_image() is used.
*
* @since 6.3.0
*
* @param string $context The context. Default 'wp_get_attachment_image'.
*/
$context = apply_filters( 'wp_get_attachment_image_context', 'wp_get_attachment_image' );
$attr = wp_parse_args( $attr, $default_attr );
$loading_attr = $attr;
$loading_attr['width'] = $width;
$loading_attr['height'] = $height;
$loading_optimization_attr = wp_get_loading_optimization_attributes(
'img',
$loading_attr,
$context
);
// Add loading optimization attributes if not available.
$attr = array_merge( $attr, $loading_optimization_attr );
// Omit the `decoding` attribute if the value is invalid according to the spec.
if ( empty( $attr['decoding'] ) || ! in_array( $attr['decoding'], array( 'async', 'sync', 'auto' ), true ) ) {
unset( $attr['decoding'] );
}
/*
* If the default value of `lazy` for the `loading` attribute is overridden
* to omit the attribute for this image, ensure it is not included.
*/
if ( isset( $attr['loading'] ) && ! $attr['loading'] ) {
unset( $attr['loading'] );
}
// If the `fetchpriority` attribute is overridden and set to false or an empty string.
if ( isset( $attr['fetchpriority'] ) && ! $attr['fetchpriority'] ) {
unset( $attr['fetchpriority'] );
}
// Generate 'srcset' and 'sizes' if not already present.
if ( empty( $attr['srcset'] ) ) {
$image_meta = wp_get_attachment_metadata( $attachment_id );
if ( is_array( $image_meta ) ) {
$size_array = array( absint( $width ), absint( $height ) );
$srcset = wp_calculate_image_srcset( $size_array, $src, $image_meta, $attachment_id );
$sizes = wp_calculate_image_sizes( $size_array, $src, $image_meta, $attachment_id );
if ( $srcset && ( $sizes || ! empty( $attr['sizes'] ) ) ) {
$attr['srcset'] = $srcset;
if ( empty( $attr['sizes'] ) ) {
$attr['sizes'] = $sizes;
}
}
}
}
/** This filter is documented in wp-includes/media.php */
$add_auto_sizes = apply_filters( 'wp_img_tag_add_auto_sizes', true );
// Adds 'auto' to the sizes attribute if applicable.
if (
$add_auto_sizes &&
isset( $attr['loading'] ) &&
'lazy' === $attr['loading'] &&
isset( $attr['sizes'] ) &&
! wp_sizes_attribute_includes_valid_auto( $attr['sizes'] )
) {
$attr['sizes'] = 'auto, ' . $attr['sizes'];
}
/**
* Filters the list of attachment image attributes.
*
* @since 2.8.0
*
* @param string[] $attr Array of attribute values for the image markup, keyed by attribute name.
* See wp_get_attachment_image().
* @param WP_Post $attachment Image attachment post.
* @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).
*/
$attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment, $size );
$attr = array_map( 'esc_attr', $attr );
$html = rtrim( "<img $hwstring" );
foreach ( $attr as $name => $value ) {
$html .= " $name=" . '"' . $value . '"';
}
$html .= ' />';
}
/**
* Filters the HTML img element representing an image attachment.
*
* @since 5.6.0
*
* @param string $html HTML img element or empty string on failure.
* @param int $attachment_id Image attachment ID.
* @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 bool $icon Whether the image should be treated as an icon.
* @param string[] $attr Array of attribute values for the image markup, keyed by attribute name.
* See wp_get_attachment_image().
*/
return apply_filters( 'wp_get_attachment_image', $html, $attachment_id, $size, $icon, $attr );
}
Cвязанные функции