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

Parameters

$attachment_idint

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 be treated as an icon. Default false.Default: false

Return

string|false

Attachment URL or false if no image is available. If $size does not match any registered image size, the original image URL will be returned.

Uses · 1

• wp_get_attachment_image_src()Retrieves an image to represent an attachment.

Used by · 3

• get_site_icon_url()Returns the Site Icon URL.
• get_the_post_thumbnail_url()Returns the post thumbnail URL.
• wp_get_attachment_thumb_url()Retrieves URL for an attachment thumbnail.

Source

View on Trac ↗View on GitHub ↗

1250function wp_get_attachment_image_url( $attachment_id, $size = 'thumbnail', $icon = false ) {1251	$image = wp_get_attachment_image_src( $attachment_id, $size, $icon );1252	return $image[0] ?? false;1253}

History

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/media.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.