Description

Gets an HTML img element representing an image attachment.

While $size will accept an array, it is better to register a size with add_image_size() so that a cropped version is generated. It's much more efficient than having to find the closest-sized image and then having the browser scale down the image.

Usage

$string = wp_get_attachment_image( $attachment_id, $size, $icon, $attr );

Parameters

$attachment_id

( int ) required – Image attachment ID.

$size

( string|int[] ) optional default: thumbnail – Optional. Image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order). Default 'thumbnail'.

$icon

( bool ) optional – Optional. Whether the image should be treated as an icon. Default false.

$attr

( string|array ) optional – { Optional. Attributes for the image markup.

$src

( string ) optional – Image attachment URL.

$class

( string ) optional – CSS class name or space-separated list of classes. Default `attachment-$size_class size-$size_class`, where $size_class is the image size being requested.

$alt

( string ) optional – Image description for the alt attribute.

$srcset

( string ) optional – The 'srcset' attribute value.

$sizes

( string ) optional – The 'sizes' attribute value.

$loading

( string|false ) optional – The '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

( string ) optional – The 'decoding' attribute value. Possible values are 'async' (default), 'sync', or 'auto'. Passing false or an empty string will result in the attribute being omitted. }

Returns

string HTML img element or empty string on failure.

Source

File name: wordpress/wp-includes/media.php
Lines:

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

    
/**
 * 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 . '"';
    }

 

 View on GitHub View on Trac