get_attachment_link( int|object $post = null, bool $leavename = false )

Retrieves the permalink for an attachment.

Contents

Description Description

This can be used in the WordPress Loop or outside of it.

Parameters 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

Top ↑

Return Return

(string) The attachment permalink.

Top ↑

Source Source

File: wp-includes/link-template.php 

function get_attachment_link( $post = null, $leavename = false ) {
	global $wp_rewrite;

	$link = false;

	$post   = get_post( $post );
	$parent = ( $post->post_parent > 0 && $post->post_parent != $post->ID ) ? get_post( $post->post_parent ) : false;
	if ( $parent && ! in_array( $parent->post_type, get_post_types() ) ) {
		$parent = false;
	}

	if ( $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
	 *
	 * @param string $link    The attachment's permalink.
	 * @param int    $post_id Attachment ID.
	 */
	return apply_filters( 'attachment_link', $link, $post->ID );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.0.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/formatting.php: trailingslashit()

Appends a trailing slash.
wp-includes/link-template.php: home_url()

Retrieves the URL for the current site where the front end is accessible.
wp-includes/link-template.php: _get_page_link()

Retrieves the page permalink.
wp-includes/link-template.php: get_permalink()

Retrieves the full permalink for the current post or post ID.
wp-includes/link-template.php: attachment_link

Filters the permalink for an attachment.
wp-includes/link-template.php: user_trailingslashit()

Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.
wp-includes/post.php: get_post_types()

Get a list of all registered post type objects.
wp-includes/class-wp-rewrite.php: WP_Rewrite::using_permalinks()

Determines whether permalinks are being used.
Show 6 more uses Hide more uses

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/widgets/class-wp-widget-media-image.php: WP_Widget_Media_Image::render_media()

Render the media on the frontend.
wp-admin/includes/media.php: image_media_send_to_editor()

Retrieves the media element HTML to send to the editor.
wp-admin/includes/media.php: media_upload_form_handler()

Handles form submissions for the legacy media uploader.
wp-admin/includes/media.php: image_link_input_fields()

Retrieve HTML for the Link URL buttons with the default link type as specified.
wp-admin/includes/post.php: _fix_attachment_links()

Replace hrefs of attachment anchors with up-to-date permalinks.
wp-admin/includes/ajax-actions.php: wp_ajax_send_attachment_to_editor()

Ajax handler for sending an attachment to the editor.
wp-includes/deprecated.php: get_the_attachment_link()

Retrieve HTML content of attachment image with link.
wp-includes/link-template.php: get_permalink()

Retrieves the full permalink for the current post or post ID.
wp-includes/post-template.php: wp_get_attachment_link()

Retrieve an attachment page link using an image or icon, if possible.
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/canonical.php: redirect_canonical()

Redirects incoming links to the proper URL based on the site url.
Show 6 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: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Default Usage
    As the tag does not display the permalink, the example uses the PHP echo command.

    <?php 
$attachment_id = 1; // ID of attachment
$attachment_page = get_attachment_link( $attachment_id ); 
?>
<a href="<?php echo esc_url( $attachment_page ); ?>"><?php echo get_the_title( $attachment_id ); ?></a>
  2. Skip to note 2 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 Codex —

    Display attached images and titles as a list
    To display the images attached to a certain page and display them as a list of bullets you can use the following:

    <ul>
<?php if ( have_posts() ) : while ( have_posts() ) : the_post();    

	$args = array(
		'post_type'   => 'attachment',
		'numberposts' => -1,
		'post_status' => null,
		'post_parent' => $post->ID
	);

	$attachments = get_posts( $args );
	if ( $attachments ) {
		foreach ( $attachments as $attachment ) {
			echo '<li>';
			the_attachment_link( $attachment->ID, true );
			echo '<p>';
			echo apply_filters( 'the_title', $attachment->post_title );
			echo '</p></li>';
		}
	}
endwhile; endif; ?>
</ul>

    Expand full source codeCollapse full source code

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