block_core_image_print_lightbox_overlay()

Compatibility

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

Performance profile

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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

48–68

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

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

• hookthird-party callbacksapply_filters()one call below block_core_image_print_lightbox_overlay()

Further down the call graph this can also reach option, cache, serialize, transient and query. 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_print_lightbox_overlay() can have, taken from its control-flow graph on PHP 8.5.

Uses · 5

• esc_attr__()Retrieves the translation of $text and escapes it for safe use in an attribute.
• esc_attr_x()Translates string with gettext context, and escapes it for safe use in an attribute.
• wp_theme_has_theme_json()Checks whether a theme or its parent has a theme.json file.
• wp_get_global_styles()Gets the styles resulting of merging core, theme, and user data.
• esc_attr()Escaping for HTML attributes.

Source code

View on Trac ↗View on GitHub ↗

323function block_core_image_print_lightbox_overlay() {324	$dialog_label      = esc_attr__( 'Enlarged images' );325	$close_button_text = esc_attr__( 'Close' );326	$prev_button_text  = esc_attr_x( 'Previous', 'previous image in lightbox' );327	$next_button_text  = esc_attr_x( 'Next', 'next image in lightbox' );328	$close_button_icon = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" focusable="false"><path d="m13.06 12 6.47-6.47-1.06-1.06L12 10.94 5.53 4.47 4.47 5.53 10.94 12l-6.47 6.47 1.06 1.06L12 13.06l6.47 6.47 1.06-1.06L13.06 12Z"></path></svg>';329	$prev_button_icon  = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="28" height="28" aria-hidden="true" focusable="false"><path d="M14.6 7l-1.2-1L8 12l5.4 6 1.2-1-4.6-5z"></path></svg>';330	$next_button_icon  = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="28" height="28" aria-hidden="true" focusable="false"><path d="M10.6 6L9.4 7l4.6 5-4.6 5 1.2 1 5.4-6z"></path></svg>';331 332	// If the current theme does NOT have a `theme.json`, or the colors are not333	// defined, it needs to set the background color & close button color to some334	// default values because it can't get them from the Global Styles.335	$background_color   = '#fff';336	$close_button_color = '#000';337	if ( wp_theme_has_theme_json() ) {338		$global_styles_color = wp_get_global_styles( array( 'color' ) );339		if ( ! empty( $global_styles_color['background'] ) ) {340			$background_color = esc_attr( $global_styles_color['background'] );341		}342		if ( ! empty( $global_styles_color['text'] ) ) {343			$close_button_color = esc_attr( $global_styles_color['text'] );344		}345	}346 347	echo <<<HTML348		<div349			class="wp-lightbox-overlay zoom"350			aria-label="{$dialog_label}"351			data-wp-interactive="core/image"352			data-wp-router-region='{ "id": "core/image-overlay", "attachTo": "body" }'353			data-wp-key="wp-lightbox-overlay"354			data-wp-context='{}'355			data-wp-bind--role="state.roleAttribute"356			data-wp-bind--aria-label="state.ariaLabel"357			data-wp-bind--aria-modal="state.ariaModal"358			data-wp-class--active="state.overlayEnabled"359			data-wp-class--show-closing-animation="state.overlayOpened"360			data-wp-watch---focus="callbacks.setOverlayFocus"361			data-wp-watch---inert="callbacks.setInertElements"362			data-wp-on--keydown="actions.handleKeydown"363			data-wp-on--touchstart="actions.handleTouchStart"364			data-wp-on--touchmove="actions.handleTouchMove"365			data-wp-on--touchend="actions.handleTouchEnd"366			data-wp-on--click="actions.hideLightbox"367			data-wp-on-window--resize="callbacks.setOverlayStyles"368			data-wp-on-window--scroll="actions.handleScroll"369			data-wp-bind--style="state.overlayStyles"370			tabindex="-1"371			>372				<button type="button" style="fill:{$close_button_color}" class="wp-lightbox-close-button" data-wp-bind--aria-label="state.closeButtonAriaLabel">373					<span class="wp-lightbox-close-icon" data-wp-bind--hidden="!state.hasNavigationIcon">{$close_button_icon}</span>374					<span class="wp-lightbox-close-text" data-wp-bind--hidden="!state.hasNavigationText">{$close_button_text}</span>375				</button>376				<button type="button" style="fill:{$close_button_color}" class="wp-lightbox-navigation-button wp-lightbox-navigation-button-prev" data-wp-bind--hidden="!state.hasNavigation" data-wp-on--click="actions.showPreviousImage" data-wp-bind--aria-label="state.prevButtonAriaLabel">377					<span class="wp-lightbox-navigation-icon" data-wp-bind--hidden="!state.hasNavigationIcon">{$prev_button_icon}</span>378					<span class="wp-lightbox-navigation-text" data-wp-bind--hidden="!state.hasNavigationText">{$prev_button_text}</span>379				</button>380				<div class="lightbox-image-container">381					<figure data-wp-bind--class="state.selectedImage.figureClassNames" data-wp-bind--style="state.figureStyles">382						<img data-wp-bind--alt="state.selectedImage.alt" data-wp-bind--class="state.selectedImage.imgClassNames" data-wp-bind--style="state.imgStyles" data-wp-bind--src="state.selectedImage.currentSrc">383					</figure>384				</div>385				<div class="lightbox-image-container">386					<figure data-wp-bind--class="state.selectedImage.figureClassNames" data-wp-bind--style="state.figureStyles">387						<img388							data-wp-bind--alt="state.selectedImage.alt"389							data-wp-bind--class="state.selectedImage.imgClassNames"390							data-wp-bind--style="state.imgStyles"391							data-wp-bind--src="state.enlargedSrc"392							data-wp-bind--srcset="state.enlargedSrcset"393							sizes="100vw"394						>395					</figure>396				</div>397				<button type="button" style="fill:{$close_button_color}" class="wp-lightbox-navigation-button wp-lightbox-navigation-button-next" data-wp-bind--hidden="!state.hasNavigation" data-wp-on--click="actions.showNextImage" data-wp-bind--aria-label="state.nextButtonAriaLabel">398					<span class="wp-lightbox-navigation-text" data-wp-bind--hidden="!state.hasNavigationText">{$next_button_text}</span>399					<span class="wp-lightbox-navigation-icon" data-wp-bind--hidden="!state.hasNavigationIcon">{$next_button_icon}</span>400				</button>401				<div data-wp-text="state.ariaLabel" aria-live="polite" aria-atomic="true" class="screen-reader-text"></div>402				<div class="scrim" style="background-color: {$background_color}" aria-hidden="true"></div>

Changelog

Introduced in 6.5.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.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.