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

Retrieves an image to represent an attachment.

Parameters
Return
Source
Hooks
Related
- Uses
- Used By
Changelog
User Contributed Notes

Parameters

$attachment_id int Required: Image attachment ID.
$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 'thumbnail'.

Default: 'thumbnail'
$icon bool Optional: Whether the image should fall back to a mime type icon.

Default: false

Top ↑

Return

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

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.

Top ↑

Source

File: wp-includes/media.php. View all references

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

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

		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 on Trac View on GitHub

Top ↑

Hooks

apply_filters( 'icon_dir', string $path )

Filters the icon directory path.

apply_filters( 'wp_get_attachment_image_src', array|false $image, int $attachment_id, string|int[] $size, bool $icon )

Filters the attachment image source result.

Top ↑

Uses

Uses
Uses	Description
wp_getimagesize() wp-includes/media.php	Allows PHP’s getimagesize() to be debuggable when necessary.
image_downsize() wp-includes/media.php	Scales an image to fit a particular size (such as ‘thumb’ or ‘medium’).
wp_mime_type_icon() wp-includes/post.php	Retrieves the icon for a MIME type or attachment.
wp_basename() wp-includes/formatting.php	i18n-friendly version of basename().
apply_filters() wp-includes/plugin.php	Calls the callback functions that have been added to a filter hook.

Show 2 more uses Hide more uses

Top ↑

Used By

Used By
Used By	Description
WP_REST_Attachments_Controller::prepare_item_for_response() wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php	Prepares a single attachment output for response.
get_oembed_response_data_rich() wp-includes/embed.php	Filters the oEmbed response data to return an iframe embed code.
wp_get_attachment_image_srcset() wp-includes/media.php	Retrieves the value for an image attachment’s ‘srcset’ attribute.
wp_get_attachment_image_sizes() wp-includes/media.php	Retrieves the value for an image attachment’s ‘sizes’ attribute.
wp_get_attachment_image_url() wp-includes/media.php	Gets the URL of an image attachment.
wp_save_image() wp-admin/includes/image-edit.php	Saves image to post, along with enqueued changes in `$_REQUEST['history']`.
edit_form_image_editor() wp-admin/includes/media.php	Displays the image and editor in the post editor
get_media_item() wp-admin/includes/media.php	Retrieves HTML form for modifying the image attachment.
Custom_Image_Header::step_2() wp-admin/includes/class-custom-image-header.php	Display second step of custom header image page.
Custom_Background::wp_set_background_image() wp-admin/includes/class-custom-background.php
Custom_Background::handle_upload() wp-admin/includes/class-custom-background.php	Handles an Image upload for the background image.
wp_prepare_attachment_for_js() wp-includes/media.php	Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model.
wp_playlist_shortcode() wp-includes/media.php	Builds the Playlist shortcode output.
wp_get_attachment_image() wp-includes/media.php	Gets an HTML img element representing an image attachment.

Show 9 more used by Hide more used by

Top ↑

Changelog

Changelog
Version	Description
2.5.0	Introduced.

Top ↑

User Contributed Notes

Skip to note 1 content

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

Contributed by Marc Heatley — 6 years ago
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

Contributed by Codex — 8 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; ?>

Contributed by Codex — 8 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 4 content

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

Contributed by blexfort — 3 years ago
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 5 content

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

Contributed by OlalaWeb — 8 years ago

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 6 content

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

Contributed by Codex — 8 years ago
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

Contributed by CdWritted — 6 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 8 content

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

Contributed by Hay — 3 years ago
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

Contributed by salem80 — 1 year 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 10 content

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

Contributed by tazotodua — 6 years ago
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

You must log in before being able to contribute a note or feedback.

Developer Resources

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

Contents

Parameters

Return

Source

Hooks

Changelog

User Contributed Notes