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

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

string

HTML content.

Hooks fired · 2

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

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

   Filters the list of attachment link attributes.

2. 2
   apply_filters( wp_get_attachment_link )filterline 1715 (+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

View on Trac ↗View on GitHub ↗

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

History

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 7.0.4 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.