wp_get_attachment_image_src() – Function

Retrieves an image to represent an attachment.

Parameters

$attachment_idintrequired: Image attachment ID.
$sizestring|int[]optional: Image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order). Default 'thumbnail'.
Default:'thumbnail'
$iconbooloptional: Whether the image should fall back to a mime type icon.
Default:false

Return

array|false Array of image data, or boolean false if no image is available.

0 string
Image source URL.
1 int
Image width in pixels.
2 int
Image height in pixels.
3 bool
Whether the image is a resized image.

Source

function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon = false ) {
	// Get a thumbnail or intermediate image if there is one.
	$image = image_downsize( $attachment_id, $size );
	if ( ! $image ) {
		$src = false;

		if ( $icon ) {
			$src = wp_mime_type_icon( $attachment_id, '.svg' );

			if ( $src ) {
				/** This filter is documented in wp-includes/post.php */
				$icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' );

				$src_file = $icon_dir . '/' . wp_basename( $src );

				list( $width, $height ) = wp_getimagesize( $src_file );

				$ext = strtolower( substr( $src_file, -4 ) );

				if ( '.svg' === $ext ) {
					// SVG does not have true dimensions, so this assigns width and height directly.
					$width  = 48;
					$height = 64;
				} else {
					list( $width, $height ) = wp_getimagesize( $src_file );
				}
			}
		}

		if ( $src && $width && $height ) {
			$image = array( $src, $width, $height, false );
		}
	}
	/**
	 * Filters the attachment image source result.
	 *
	 * @since 4.3.0
	 *
	 * @param array|false  $image         {
	 *     Array of image data, or boolean false if no image is available.
	 *
	 *     @type string $0 Image source URL.
	 *     @type int    $1 Image width in pixels.
	 *     @type int    $2 Image height in pixels.
	 *     @type bool   $3 Whether the image is a resized image.
	 * }
	 * @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.
	 */
	return apply_filters( 'wp_get_attachment_image_src', $image, $attachment_id, $size, $icon );
}

View all references View on Trac View on GitHub

Changelog

Version	Description
2.5.0	Introduced.

User Contributed Notes

Skip to note 11 content

Marc Heatley 7 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 22You must log in to vote on the helpfulness of this note
The #return section gives keys, but the function just returns indexes. We should make it clearer what is returned by this function. And some description or a link to explain is_intermediate
```
array{
	[0] => url,
	[1] => width</em>
	[2] => height</em>
	[4] => is_intermediate
}
```
Log in to add feedback

Codex 9 years ago

Default Usage

$image_attributes = wp_get_attachment_image_src( $attachment_id = 8 );
if ( $image_attributes ) : ?>
	<img src="<?php echo $image_attributes[0]; ?>" width="<?php echo $image_attributes[1]; ?>" height="<?php echo $image_attributes[2]; ?>" />
<?php endif; ?>

Codex 9 years ago

Show the first image associated with the post
This function retrieves the first image associated with a post.

/**
 * Output a post's first image.
 *
 * @param int $post_id Post ID.
 */
function wpdocs_echo_first_image( $post_id ) {
	$args = array(
		'posts_per_page' => 1,
		'order'          => 'ASC',
		'post_mime_type' => 'image',
		'post_parent'    => $post_id,
		'post_status'    => null,
		'post_type'      => 'attachment',
	);

	$attachments = get_children( $args );

	if ( $attachments ) {
		echo '<img src="' . wp_get_attachment_thumb_url( $attachments[0]->ID ) . '" class="current">';
	}
}

Skip to note 14 content

blexfort 5 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note
To get original size URL image in the function wp_get_attachment_image_src use:
```
$img_atts = wp_get_attachment_image_src($IMG_ID, 'full');
<img src="<?php echo $img_atts[0]; ?>"
```
Log in to add feedback
Skip to note 15 content

OlalaWeb 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

Tips: Return values ( [1] width [2] height [3] resize ) seems to be empty when using the Jetpack plugin.

Log in to add feedback
Skip to note 16 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
Change Icon Directory
WordPress can use media icons to represent attachment files on your blog and in the Admin interface, if those icons are available.
For images, it returns the thumbnail. For other media types, it looks for image files named by media type (e.g., audio.jpg) in the directory wp-includes/images/crystal/.

This example shows how you can change this directory to a folder called “images” in your theme: wp-content/themes/yourtheme/images. Create the folder and put “media type images” in there. To tell WordPress the directory has changed, put this in the current theme’s functions.php file:
```
add_filter( 'icon_dir', 'wpdocs_theme_icon_directory' );
add_filter( 'icon_dir_uri', 'wpdocs_theme_icon_uri' );

/*
 * Return my desired icon directory
 */
function wpdocs_theme_icon_directory( $icon_dir ) {
	return get_stylesheet_directory() . '/images';
}

/*
 * Return my desired icon URI
 */
function wpdocs_theme_icon_uri( $icon_dir ) {
	return get_stylesheet_directory_uri() . '/images'; 
}
```
Log in to add feedback

CdWritted 8 years ago

Retrieve the post thumbnail url sized as 220 if thumbnail exists.

$args = array( 'post_type' => 'post', 'post_status' => 'publish', 'posts_per_page' => 5, 'numberposts' => 5 );

$posts = get_posts( $args );

foreach($posts as $post) {
	$thumbnail_url = wp_get_attachment_image_src(get_post_thumbnail_id($post->ID), array('220','220'), true );
	$thumbnail_url = $thumbnail_url[0];
	echo ( !empty($thumbnail_url) ) ? $thumbnail_url : 'No thumb!';
}

Skip to note 18 content

Hay 4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
A couple of notes on this page mention getting the first image in a post based on get_children. Unfortunately, that won’t work if you’re using the Gutenberg editor. To get the first image from a Gutenberg-based post, you need to parse the blocks. Here’s a function that will return the ID of the first image in a post, or null if there is none.
```
function first_image_in_blocks( $id ) {
    $post = get_post( $id );
    $blocks = parse_blocks( $post->post_content );

    // Get all blocks that have a core/image blockName
    $images = array_filter( $blocks, function( $block ) {
        return 'core/image' === $block['blockName'];
    } );

    // If there are any images, get the id from the first image, otherwise
    // return null
    return count( $images ) > 0 ? $images[0]['attrs']['id'] : null;
}
```
Log in to add feedback

salem80 3 years ago

Here is my code to create custom gallery from post attachment only (I use it in ‘singl.php‘ for specified category)

<!-- begin gallery -->
<?php  if  ( get_the_category()[0]->slug == 'gallery' )  {     ?>
<div class="gallery" id ='lightgallery' >
<?php $attachments = get_posts( array(  'post_type'  => 'attachment', 'post_parent' => $post->ID ) );
if ( $attachments ) {
foreach ( $attachments as $post ) {
echo '<a href="'.wp_get_attachment_image_src( $post->ID, 'full' )[0].'">'  ;
echo  '<img  src="'.wp_get_attachment_image_src( $post->ID )[0].'"  >  </a>';  
 }
 wp_reset_postdata();
 }  ?>
</div>
<?php   }    ?> 
<!-- End gallery -->

Skip to note 20 content

tazotodua 7 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -6You must log in to vote on the helpfulness of this note
the function returns:
```
array (size=4)
  0 => string 'http://example.com/wp-content/uploads/2017/11/image-name-150x150.jpg' (length=72)
  1 => int 150
  2 => int 150
  3 => boolean true
```
Log in to add feedback

wp_get_attachment_image_src( int $attachment_id, string|int[] $size = ‘thumbnail’, bool $icon = false ): array|false

In this article

Parameters

Return

Source

Changelog

User Contributed Notes