wppaste
WordPress

block_core_gallery_dynamic_image_link_attributes( int $attachment_id, array $attributes ): array

Since
7.0.0
Source
wp-includes/blocks/gallery.php:179
Builds the link-related image block attributes for a dynamically rendered gallery image, mapping the gallery-wide linkTo setting onto a single image.

Description

Mirrors the editor's getHrefAndDestination() (see gallery/utils.js).

Compatibility

WordPress
since 7.0.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in 1 of the 5 tracked releases, added in 7.0.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$attachment_idint
The image attachment ID.
$attributesarray
The gallery block attributes.

Return value

array
Partial image block attributes (href, linkDestination, linkTarget, rel, lightbox).

Performance profile

How much work a call to block_core_gallery_dynamic_image_link_attributes() 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
10–36

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

  • querycontent queryget_post()one call below block_core_gallery_dynamic_image_link_attributes()
  • hookthird-party callbacksapply_filters()one call below block_core_gallery_dynamic_image_link_attributes()
  • optionoption read or writeget_option()one call below block_core_gallery_dynamic_image_link_attributes()

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 · 3 distinct outcomes

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

WhenInstructionsCalls it makes
always10–31none
always18–32wp_get_attachment_url()
always18–36get_attachment_link()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev4810–3610
8.54810–3610
8.44810–3610
8.34810–3610
8.24810–36101 more instruction than PHP 8.1
8.14710–3810
7.44710–3810

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

Used by · 1

Source code

function block_core_gallery_dynamic_image_link_attributes( $attachment_id, $attributes ) {	$link_to = $attributes['linkTo'] ?? 'none';	$attrs   = array(); 	switch ( $link_to ) {		// Gutenberg uses 'media'/'attachment'; WP Core uses 'file'/'post'.		case 'media':		case 'file':			$attrs['href']            = wp_get_attachment_url( $attachment_id );			$attrs['linkDestination'] = 'media';			break;		case 'attachment':		case 'post':			$attrs['href']            = get_attachment_link( $attachment_id );			$attrs['linkDestination'] = 'attachment';			break;		case 'lightbox':			$attrs['linkDestination'] = 'none';			$attrs['lightbox']        = array( 'enabled' => true );			break;	} 	if ( ! empty( $attrs['href'] ) && '_blank' === ( $attributes['linkTarget'] ?? '' ) ) {		$attrs['linkTarget'] = '_blank';		$attrs['rel']        = 'noopener';	} 	return $attrs;}

Changelog

Introduced in 7.0.0.

Signature, return type and hooks compared across 1 parsed release.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/blocks/gallery.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.