block_core_gallery_render_dynamic_image( int $attachment_id, array $attributes, array $context ): string

Description

Compatibility

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.

$contextarray

Context to expose to the inner image block.

Return value

string

The rendered image block HTML, or an empty string on failure.

Performance profile

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

21–127

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

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()called directly
• hookthird-party callbacksapply_filters()one call below block_core_gallery_render_dynamic_image()

Further down the call graph this can also reach option, 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 · 18 distinct outcomes

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

Uses · 9

• safecss_filter_attr()Filters an inline style attribute and removes disallowed rules.
• wp_get_attachment_image()Gets an HTML img element representing an image attachment.
• block_core_gallery_dynamic_image_link_attributes()Builds the link-related image block attributes for a dynamically rendered gallery image, mapping the gallery-wide `linkTo` setting onto a single image.
• esc_url()Checks and cleans a URL.
• esc_attr()Escaping for HTML attributes.
• get_post()Retrieves post data given a post ID or post object.
• wp_kses_post()Sanitizes content for allowed HTML tags for post content.
• new WP_Block($image_block, $context)::render()
• WP_Block::__construct()Constructor.

Used by · 1

• block_core_gallery_render()Renders the `core/gallery` block on the server.

Source code

View on Trac ↗View on GitHub ↗

225function block_core_gallery_render_dynamic_image( $attachment_id, $attributes, $context ) {226	$size_slug    = $attributes['sizeSlug'] ?? 'large';227	$aspect_ratio = $attributes['aspectRatio'] ?? 'auto';228 229	$img_attr = array( 'class' => 'wp-image-' . $attachment_id );230	if ( $aspect_ratio && 'auto' !== $aspect_ratio ) {231		// Run the aspect ratio through the same sanitization used for every other232		// block inline style, so an unsafe value can't break out of the style233		// attribute or inject additional markup.234		$img_attr['style'] = safecss_filter_attr(235			sprintf( 'aspect-ratio:%s;object-fit:cover;', $aspect_ratio )236		);237	}238 239	$image_markup = wp_get_attachment_image( $attachment_id, $size_slug, false, $img_attr );240	if ( ! $image_markup ) {241		return '';242	}243 244	$image_attributes = array_merge(245		array(246			'id'       => $attachment_id,247			'data-id'  => (string) $attachment_id,248			'sizeSlug' => $size_slug,249		),250		block_core_gallery_dynamic_image_link_attributes( $attachment_id, $attributes )251	);252 253	if ( $aspect_ratio && 'auto' !== $aspect_ratio ) {254		$image_attributes['aspectRatio'] = $aspect_ratio;255		$image_attributes['scale']       = 'cover';256	}257 258	// Wrap in a link when the gallery links images somewhere.259	if ( ! empty( $image_attributes['href'] ) ) {260		$image_markup = sprintf(261			'<a href="%1$s"%2$s%3$s>%4$s</a>',262			esc_url( $image_attributes['href'] ),263			isset( $image_attributes['linkTarget'] ) ? ' target="' . esc_attr( $image_attributes['linkTarget'] ) . '"' : '',264			isset( $image_attributes['rel'] ) ? ' rel="' . esc_attr( $image_attributes['rel'] ) . '"' : '',265			$image_markup266		);267	}268 269	// Use the raw caption (`post_excerpt`) so the frontend mirrors the editor270	// preview, which builds the caption from the REST `caption.raw` value. Gap:271	// the REST API exposes no caption run through `wp_get_attachment_caption`, so272	// that filter isn't applied here either.273	$attachment = get_post( $attachment_id );274	$caption    = $attachment ? $attachment->post_excerpt : '';275	if ( '' !== $caption ) {276		$image_markup .= sprintf(277			'<figcaption class="wp-element-caption">%s</figcaption>',278			wp_kses_post( $caption )279		);280	}281 282	$figure = sprintf(283		'<figure class="wp-block-image size-%1$s">%2$s</figure>',284		esc_attr( $size_slug ),285		$image_markup286	);287 288	$image_block = array(289		'blockName'    => 'core/image',290		'attrs'        => $image_attributes,291		'innerBlocks'  => array(),292		'innerHTML'    => $figure,293		'innerContent' => array( $figure ),294	);295 296	return ( new WP_Block( $image_block, $context ) )->render();297}

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.