get_attachment_link() WordPress Function
The get_attachment_link() function is used to get the URL for an attachment. It can be used with images, videos, and other types of attachments.
get_attachment_link( int|object $post = null, bool $leavename = false ) #
Retrieves the permalink for an attachment.
Description
This can be used in the WordPress Loop or outside of it.
Parameters
- $post
(int|object)(Optional) Post ID or object. Default uses the global
$post
.Default value: null
- $leavename
(bool)(Optional) Whether to keep the page name.
Default value: false
Return
(string) The attachment permalink.
More Information
Under a “pretty” permalink structure, the function returns something like http://wp.example.net/path_to_post/post_name/attachment_name.
Under the default permalink structure — or if WordPress can’t construct a pretty URI — the function returns something like http://wp.example.net/?attachment_id=n, where n is the attachment ID number.
You can change the output of this function through the attachment_link filter.
If you want a direct link to the attached file (instead of the attachment page), you can use the function wp_get_attachment_url(id) instead.
Note: that get_attachment_link actually returns an URI, whereas wp_get_attachment_link() returns an HTML hyperlink.
Source
File: wp-includes/link-template.php
function get_attachment_link( $post = null, $leavename = false ) { global $wp_rewrite; $link = false; $post = get_post( $post ); $force_plain_link = wp_force_plain_post_permalink( $post ); $parent_id = $post->post_parent; $parent = $parent_id ? get_post( $parent_id ) : false; $parent_valid = true; // Default for no parent. if ( $parent_id && ( $post->post_parent === $post->ID || ! $parent || ! is_post_type_viewable( get_post_type( $parent ) ) ) ) { // Post is either its own parent or parent post unavailable. $parent_valid = false; } if ( $force_plain_link || ! $parent_valid ) { $link = false; } elseif ( $wp_rewrite->using_permalinks() && $parent ) { if ( 'page' === $parent->post_type ) { $parentlink = _get_page_link( $post->post_parent ); // Ignores page_on_front. } else { $parentlink = get_permalink( $post->post_parent ); } if ( is_numeric( $post->post_name ) || false !== strpos( get_option( 'permalink_structure' ), '%category%' ) ) { $name = 'attachment/' . $post->post_name; // <permalink>/<int>/ is paged so we use the explicit attachment marker. } else { $name = $post->post_name; } if ( strpos( $parentlink, '?' ) === false ) { $link = user_trailingslashit( trailingslashit( $parentlink ) . '%postname%' ); } if ( ! $leavename ) { $link = str_replace( '%postname%', $name, $link ); } } elseif ( $wp_rewrite->using_permalinks() && ! $leavename ) { $link = home_url( user_trailingslashit( $post->post_name ) ); } if ( ! $link ) { $link = home_url( '/?attachment_id=' . $post->ID ); } /** * Filters the permalink for an attachment. * * @since 2.0.0 * @since 5.6.0 Providing an empty string will now disable * the view attachment page link on the media modal. * * @param string $link The attachment's permalink. * @param int $post_id Attachment ID. */ return apply_filters( 'attachment_link', $link, $post->ID ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.0.0 | Introduced. |