block_core_image_render_lightbox( string $block_content, array $block, WP_Block $block_instance ): string

Compatibility

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

Parameters

$block_contentstring

Rendered block content.

$blockarray

Block object.

$block_instanceWP_Block

Block instance.

Return value

string

Filtered block content.

Performance profile

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

185–243

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

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

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

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 11

• wp_interactivity_config()Gets and/or sets the configuration of the Interactivity API for a given store namespace.
• __()Retrieves the translation of $text.
• esc_html__()Retrieves the translation of $text and escapes it for safe use in HTML output.
• esc_html_x()Translates string with gettext context, and escapes it for safe use in HTML output.
• wp_get_attachment_url()Retrieves the URL for an attachment.
• wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
• wp_get_attachment_image_srcset()Retrieves the value for an image attachment's 'srcset' attribute.
• wp_interactivity_state()Gets and/or sets the initial state of an Interactivity API store for a given namespace.
• wp_json_encode()Encodes a variable into JSON, with some confidence checks.
• add_action()Adds a callback function to an action hook.
• WP_HTML_Tag_Processor::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

180function block_core_image_render_lightbox( $block_content, array $block, WP_Block $block_instance ) {181	/*182	 * If there's no IMG tag in the block then return the given block content183	 * as-is. There's nothing that this code can knowingly modify to add the184	 * lightbox behavior.185	 */186	$processor = new WP_HTML_Tag_Processor( $block_content );187 188	if ( $processor->next_tag( 'figure' ) ) {189		$processor->set_bookmark( 'figure' );190	}191	if ( ! $processor->next_tag( 'img' ) ) {192		return $block_content;193	}194 195	$alt              = $processor->get_attribute( 'alt' );196	$img_uploaded_src = $processor->get_attribute( 'src' );197	$img_class_names  = $processor->get_attribute( 'class' );198	$img_styles       = $processor->get_attribute( 'style' );199	$img_width        = 'none';200	$img_height       = 'none';201	$img_srcset       = false;202 203	wp_interactivity_config(204		'core/image',205		array(206			'defaultAriaLabel' => __( 'Enlarged image' ),207			'closeButtonText'  => esc_html__( 'Close' ),208			'prevButtonText'   => esc_html_x( 'Previous', 'previous image in lightbox' ),209			'nextButtonText'   => esc_html_x( 'Next', 'next image in lightbox' ),210		)211	);212 213	if ( $alt ) {214		/* translators: %s: Image alt text. */215		$custom_aria_label = sprintf( __( 'Enlarged image: %s' ), $alt );216	}217 218	if ( isset( $block['attrs']['id'] ) ) {219		$img_uploaded_src = wp_get_attachment_url( $block['attrs']['id'] );220		$img_metadata     = wp_get_attachment_metadata( $block['attrs']['id'] );221		$has_dimensions   = ( $img_metadata['width'] ?? '' ) && ( $img_metadata['height'] ?? '' );222		$srcset_size      = $has_dimensions ? array( $img_metadata['width'], $img_metadata['height'] ) : 'large';223		$img_srcset       = wp_get_attachment_image_srcset( $block['attrs']['id'], $srcset_size );224		$img_width        = $img_metadata['width'] ?? 'none';225		$img_height       = $img_metadata['height'] ?? 'none';226	}227 228	// Figure.229	$processor->seek( 'figure' );230	$figure_class_names = $processor->get_attribute( 'class' );231	$figure_styles      = $processor->get_attribute( 'style' );232 233	// Create unique id and set the image metadata in the state.234	$unique_image_id = uniqid();235	wp_interactivity_state(236		'core/image',237		array(238			'metadata' => array(239				$unique_image_id => array(240					'uploadedSrc'            => $img_uploaded_src,241					'lightboxSrcset'         => $img_srcset,242					'figureClassNames'       => $figure_class_names,243					'figureStyles'           => $figure_styles,244					'imgClassNames'          => $img_class_names,245					'imgStyles'              => $img_styles,246					'targetWidth'            => $img_width,247					'targetHeight'           => $img_height,248					'scaleAttr'              => $block['attrs']['scale'] ?? false,249					'alt'                    => $alt,250					'galleryId'              => $block_instance->context['galleryId'] ?? null,251					'customAriaLabel'        => $custom_aria_label ?? null,252					'navigationButtonType'   => $block_instance->context['navigationButtonType'] ?? 'icon',253					'triggerButtonAriaLabel' => __( 'Enlarge' ),254				),255			),256		)257	);258 259	$processor->add_class( 'wp-lightbox-container' );

Changelog

Introduced in 6.4.0. 2 changes between 6.7.7 and 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.1.0 tag, from src/wp-includes/blocks/image.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.