wp_get_attachment_link( int|WP_Post $post = 0, string|int[] $size = 'thumbnail', bool $permalink = false, bool $icon = false, string|false $text = false, array|string $attr = '' ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$postint|WP_Postoptional

Post ID or post object.Default: 0

$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'

$permalinkbooloptional

Whether to add permalink to image. Default false.Default: false

$iconbooloptional

Whether the attachment is an icon. Default false.Default: false

$textstring|falseoptional

Link text to use. Activated by passing a string, false otherwise.
Default false.Default: false

$attrarray|stringoptional

Array or string of attributes. Default empty.Default: ''

Return value

string

HTML content.

Performance profile

How much work a call to wp_get_attachment_link() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

16–98

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 127.

Plugin surface

2 hooks

Third-party callbacks on 'wp_get_attachment_link_attributes', 'wp_get_attachment_link' run inside this call, and their cost is not bounded by anything here.

Called by

5

5 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below wp_get_attachment_link()

Further down the call graph this can also reach cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 10 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_attachment_link() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while wp_get_attachment_link() runs, in this order:

1. 1
   apply_filters( wp_get_attachment_link_attributes )filterline 1687 (+38 into the body)

   Filters the list of attachment link attributes.

2. 2
   apply_filters( wp_get_attachment_link )filterline 1712 (+63 into the body)

   Filters a retrieved attachment page link.

Uses · 10

• get_post()Retrieves post data given a post ID or post object.
• wp_get_attachment_url()Retrieves the URL for an attachment.
• __()Retrieves the translation of $text.
• get_attachment_link()Retrieves the permalink for an attachment.
• wp_get_attachment_image()Gets an HTML img element representing an image attachment.
• esc_html()Escaping for HTML blocks.
• get_attached_file()Retrieves attached file path based on attachment ID.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• esc_url()Checks and cleans a URL.
• esc_attr()Escaping for HTML attributes.

Used by · 5

• gallery_shortcode()Builds the Gallery shortcode output.
• get_adjacent_image_link()Gets the next or previous image link that has the same post parent.
• prepend_attachment()Wraps attachment in paragraph tag before content.
• the_attachment_link()Displays an attachment page link using an image or icon.
• wp_playlist_shortcode()Builds the Playlist shortcode output.

Source code

View on Trac ↗View on GitHub ↗

1649function wp_get_attachment_link( $post = 0, $size = 'thumbnail', $permalink = false, $icon = false, $text = false, $attr = '' ) {1650	$_post = get_post( $post );1651 1652	if ( empty( $_post ) || ( 'attachment' !== $_post->post_type ) || ! wp_get_attachment_url( $_post->ID ) ) {1653		return __( 'Missing Attachment' );1654	}1655 1656	$url = wp_get_attachment_url( $_post->ID );1657 1658	if ( $permalink ) {1659		$url = get_attachment_link( $_post->ID );1660	}1661 1662	if ( $text ) {1663		$link_text = $text;1664	} elseif ( $size && 'none' !== $size ) {1665		$link_text = wp_get_attachment_image( $_post->ID, $size, $icon, $attr );1666	} else {1667		$link_text = '';1668	}1669 1670	if ( '' === trim( $link_text ) ) {1671		$link_text = $_post->post_title;1672	}1673 1674	if ( '' === trim( $link_text ) ) {1675		$link_text = esc_html( pathinfo( get_attached_file( $_post->ID ), PATHINFO_FILENAME ) );1676	}1677 1678	/**1679	 * Filters the list of attachment link attributes.1680	 *1681	 * @since 6.2.01682	 *1683	 * @param array $attributes An array of attributes for the link markup,1684	 *                          keyed on the attribute name.1685	 * @param int   $id         Post ID.1686	 */1687	$attributes = apply_filters( 'wp_get_attachment_link_attributes', array( 'href' => $url ), $_post->ID );1688 1689	$link_attributes = '';1690	foreach ( $attributes as $name => $value ) {1691		$value            = 'href' === $name ? esc_url( $value ) : esc_attr( $value );1692		$link_attributes .= ' ' . esc_attr( $name ) . "='" . $value . "'";1693	}1694 1695	$link_html = "<a$link_attributes>$link_text</a>";1696 1697	/**1698	 * Filters a retrieved attachment page link.1699	 *1700	 * @since 2.7.01701	 * @since 5.1.0 Added the `$attr` parameter.1702	 *1703	 * @param string       $link_html The page link HTML output.1704	 * @param int|WP_Post  $post      Post ID or object. Can be 0 for the current global post.1705	 * @param string|int[] $size      Requested image size. Can be any registered image size name, or1706	 *                                an array of width and height values in pixels (in that order).1707	 * @param bool         $permalink Whether to add permalink to image. Default false.1708	 * @param bool         $icon      Whether to include an icon.1709	 * @param string|false $text      If string, will be link text.1710	 * @param array|string $attr      Array or string of attributes.1711	 */1712	return apply_filters( 'wp_get_attachment_link', $link_html, $post, $size, $permalink, $icon, $text, $attr );1713}

Changelog

Introduced in 2.5.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 6.8.8 tag, from src/wp-includes/post-template.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.