get_the_attachment_link( int $id = 0, bool $fullsize = false, array $max_dims = false, bool $permalink = false ): string

Compatibility

Deprecated in WordPress 2.5.0. Use wp_get_attachment_link()

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$idintoptional

Post ID.Default: 0

$fullsizebooloptional

Whether to use full size image. Default false.Default: false

$max_dimsarrayoptional

Max image dimensions.Default: false

$permalinkbooloptional

Whether to include permalink to image. Default false.Default: false

Return value

string

Performance profile

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

22–54

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksdo_action()one call below get_the_attachment_link()
• optionoption read or writeget_option()one call below get_the_attachment_link()

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

What one call costs · 4 distinct outcomes

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

Uses · 7

• _deprecated_function()Marks a function as deprecated and inform when it has been used.
• 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.
• esc_attr()Escaping for HTML attributes.
• get_attachment_innerHTML()Retrieve HTML content of image element.

Source code

View on Trac ↗View on GitHub ↗

1871function get_the_attachment_link($id = 0, $fullsize = false, $max_dims = false, $permalink = false) {1872	_deprecated_function( __FUNCTION__, '2.5.0', 'wp_get_attachment_link()' );1873	$id = (int) $id;1874	$_post = get_post($id);1875 1876	if ( ('attachment' != $_post->post_type) || !$url = wp_get_attachment_url($_post->ID) )1877		return __('Missing Attachment');1878 1879	if ( $permalink )1880		$url = get_attachment_link($_post->ID);1881 1882	$post_title = esc_attr($_post->post_title);1883 1884	$innerHTML = get_attachment_innerHTML($_post->ID, $fullsize, $max_dims);1885	return "<a href='$url' title='$post_title'>$innerHTML</a>";1886}

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/deprecated.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.