get_attachment_link() – Retrieves the permalink for an attachment.

You appear to be a bot. Output may be restricted

Description

Retrieves the permalink for an attachment.

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

Usage

$string = get_attachment_link( $post, $leavename );

Parameters

$post
( int|object ) optional – Optional. Post ID or object. Default uses the global `$post`.
$leavename
( bool ) optional – Optional. Whether to keep the page name. Default false.

Returns

string The attachment permalink.

Source

File name: wordpress/wp-includes/link-template.php
Lines:

1 to 64 of 64
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 );
}
 

 View on GitHub View on Trac