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

Retrieve an image to represent an attachment.

Contents

Description Description

A mime icon for files, thumbnail or intermediate size for images.

The returned array contains four values: the URL of the attachment image src, the width of the image file, the height of the image file, and a boolean representing whether the returned array describes an intermediate (generated) image size or the original, full-sized upload.

Parameters Parameters

$attachment_id

(int) (Required) Image attachment ID.

$size

(string|array) (Optional) Image size. Accepts any valid image size, or an array of width and height values in pixels (in that order).

Default value: 'thumbnail'

$icon

(bool) (Optional) Whether the image should be treated as an icon.

Default value: false

Top ↑

Return Return

(false|array) Returns an array (url, width, height, is_intermediate), or false, if no image is available.

Top ↑

Source Source

File: wp-includes/media.php

823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
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 ) ) {
            /** 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 ) = getimagesize( $src_file );
        }
 
        if ( $src && $width && $height ) {
            $image = array( $src, $width, $height );
        }
    }
    /**
     * Filters the image src result.
     *
     * @since 4.3.0
     *
     * @param array|false  $image         Either array with src, width & height, icon src, or false.
     * @param int          $attachment_id Image attachment ID.
     * @param string|array $size          Size of image. Image size or array of width and height values
     *                                    (in that order). Default 'thumbnail'.
     * @param bool         $icon          Whether the image should be treated as an icon. Default false.
     */
    return apply_filters( 'wp_get_attachment_image_src', $image, $attachment_id, $size, $icon );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/media.php: wp_get_attachment_image_src

Filters the image src result.
wp-includes/formatting.php: wp_basename()

i18n friendly version of basename()
wp-includes/plugin.php: apply_filters()

Call the functions added to a filter hook.
wp-includes/media.php: image_downsize()

Scale an image to fit a particular size (such as ‘thumb’ or ‘medium’).
wp-includes/post.php: wp_mime_type_icon()

Retrieve the icon for a MIME type.
wp-includes/post.php: icon_dir

Filters the icon directory path.
Show 1 more use Hide more uses

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php: WP_REST_Attachments_Controller::prepare_item_for_response()

Prepares a single attachment output for response.
wp-includes/embed.php: get_oembed_response_data_rich()

Filters the oEmbed response data to return an iframe embed code.
wp-includes/media.php: wp_get_attachment_image_srcset()

Retrieves the value for an image attachment’s ‘srcset’ attribute.
wp-includes/media.php: wp_get_attachment_image_sizes()

Retrieves the value for an image attachment’s ‘sizes’ attribute.
wp-includes/media.php: wp_get_attachment_image_url()

Get the URL of an image attachment.
wp-admin/includes/image-edit.php: wp_save_image()

Saves image to post along with enqueued changes in $_REQUEST[‘history’]
wp-admin/includes/media.php: edit_form_image_editor()

Displays the image and editor in the post editor
wp-admin/includes/media.php: get_media_item()

Retrieve HTML form for modifying the image attachment.
wp-admin/custom-header.php: Custom_Image_Header::step_2()

Display second step of custom header image page.
wp-admin/custom-background.php: Custom_Background::wp_set_background_image()
wp-admin/custom-background.php: Custom_Background::handle_upload()

Handle an Image upload for the background image.
wp-includes/media.php: wp_prepare_attachment_for_js()

Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model.
wp-includes/media.php: wp_playlist_shortcode()

Builds the Playlist shortcode output.
wp-includes/media.php: wp_get_attachment_image()

Get an HTML img element representing an image attachment
Show 9 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 9You must log in to vote on the helpfulness of this note
    Contributed by Marc Heatley —

    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

    1
    2
    3
    4
    5
    6
    array{
        [0] => url,
        [1] => width</em>
        [2] => height</em>
        [4] => is_intermediate
    }
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 7You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Default Usage

    1
    2
    3
    4
    $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; ?>
  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
    Contributed by Codex —

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

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    /**
     * 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">';
        }
    }

    Expand full source codeCollapse full source code

  5. Skip to note 5 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 —

    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:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    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';
    }

    Expand full source codeCollapse full source code

  6. Skip to note 6 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by CdWritted —

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

    1
    2
    3
    4
    5
    6
    7
    8
    9
    $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!';
    }

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