get_attachment_link( int|WP_Post $post = null, bool $leavename = false ): string

Description

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 object. Default uses the global $post.Default: null

$leavenamebooloptional

Whether to keep the page name. Default false.Default: false

Return value

string

The attachment permalink.

Performance profile

How much work a call to 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

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

30–92

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

Plugin surface

1 hook

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

Called by

13

13 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
• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below get_attachment_link()
• serializeserialisationmaybe_unserialize()one call below get_attachment_link()

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

What one call costs · 88 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while get_attachment_link() runs, in this order:

1. 1
   apply_filters( attachment_link )filterline 534 (+62 into the body)

   Filters the permalink for an attachment.

Uses · 12

• get_post()Retrieves post data given a post ID or post object.
• wp_force_plain_post_permalink()Determine whether post should always use a plain permalink structure.
• is_post_type_viewable()Determines whether a post type is considered "viewable".
• get_post_type()Retrieves the post type of the current post or of a given post.
• _get_page_link()Retrieves the page permalink.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• get_option()Retrieves an option value based on an option name.
• user_trailingslashit()Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
• trailingslashit()Appends a trailing slash.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 13

• WP_Widget_Media_Image::render_media()Render the media on the frontend.
• _fix_attachment_links()Replaces hrefs of attachment anchors with up-to-date permalinks.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• get_the_attachment_link()Retrieve HTML content of attachment image with link.
• image_link_input_fields()Retrieves HTML for the Link URL buttons with the default link type as specified.
• image_media_send_to_editor()Retrieves the media element HTML to send to the editor.
• media_upload_form_handler()Handles form submissions for the legacy media uploader.
• redirect_canonical()Redirects incoming links to the proper URL based on the site url.
• twentyfourteen_the_attached_image()Prints the attached image with a link to the next attached image.
• twentythirteen_the_attached_image()Prints the attached image with a link to the next attached image.
• wp_ajax_send_attachment_to_editor()Handles sending an attachment to the editor via AJAX.
• wp_get_attachment_link()Retrieves an attachment page link using an image or icon, if possible.

Source code

View on Trac ↗View on GitHub ↗

472function get_attachment_link( $post = null, $leavename = false ) {473	global $wp_rewrite;474 475	$link = false;476 477	$post             = get_post( $post );478	$force_plain_link = wp_force_plain_post_permalink( $post );479	$parent_id        = $post->post_parent;480	$parent           = $parent_id ? get_post( $parent_id ) : false;481	$parent_valid     = true; // Default for no parent.482	if (483		$parent_id &&484		(485			$post->post_parent === $post->ID ||486			! $parent ||487			! is_post_type_viewable( get_post_type( $parent ) )488		)489	) {490		// Post is either its own parent or parent post unavailable.491		$parent_valid = false;492	}493 494	if ( $force_plain_link || ! $parent_valid ) {495		$link = false;496	} elseif ( $wp_rewrite->using_permalinks() && $parent ) {497		if ( 'page' === $parent->post_type ) {498			$parentlink = _get_page_link( $post->post_parent ); // Ignores page_on_front.499		} else {500			$parentlink = get_permalink( $post->post_parent );501		}502 503		if ( is_numeric( $post->post_name ) || str_contains( get_option( 'permalink_structure' ), '%category%' ) ) {504			$name = 'attachment/' . $post->post_name; // <permalink>/<int>/ is paged so we use the explicit attachment marker.505		} else {506			$name = $post->post_name;507		}508 509		if ( ! str_contains( $parentlink, '?' ) ) {510			$link = user_trailingslashit( trailingslashit( $parentlink ) . '%postname%' );511		}512 513		if ( ! $leavename ) {514			$link = str_replace( '%postname%', $name, $link );515		}516	} elseif ( $wp_rewrite->using_permalinks() && ! $leavename ) {517		$link = home_url( user_trailingslashit( $post->post_name ) );518	}519 520	if ( ! $link ) {521		$link = home_url( '/?attachment_id=' . $post->ID );522	}523 524	/**525	 * Filters the permalink for an attachment.526	 *527	 * @since 2.0.0528	 * @since 5.6.0 Providing an empty string will now disable529	 *              the view attachment page link on the media modal.530	 *531	 * @param string $link    The attachment's permalink.532	 * @param int    $post_id Attachment ID.533	 */534	return apply_filters( 'attachment_link', $link, $post->ID );535}

Changelog

Introduced in 2.0.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/link-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.