@wordpress/block-library 8.27.2 → 8.28.0

package/src/image/index.php

@@ -20,26 +20,26 @@ function render_block_core_image( $attributes, $content, $block ) {
 		return '';
 	}
 
-	$processor = new WP_HTML_Tag_Processor( $content );
+	$p = new WP_HTML_Tag_Processor( $content );
 
-	if ( ! $processor->next_tag( 'img' ) || null === $processor->get_attribute( 'src' ) ) {
+	if ( ! $p->next_tag( 'img' ) || null === $p->get_attribute( 'src' ) ) {
 		return '';
 	}
 
 	if ( isset( $attributes['data-id'] ) ) {
-		// Add the data-id="$id" attribute to the img element
-		// to provide backwards compatibility for the Gallery Block,
-		// which now wraps Image Blocks within innerBlocks.
-		// The data-id attribute is added in a core/gallery `render_block_data` hook.
-		$processor->set_attribute( 'data-id', $attributes['data-id'] );
+		// Adds the data-id="$id" attribute to the img element to provide backwards
+		// compatibility for the Gallery Block, which now wraps Image Blocks within
+		// innerBlocks. The data-id attribute is added in a core/gallery
+		// `render_block_data` hook.
+		$p->set_attribute( 'data-id', $attributes['data-id'] );
 	}
 
 	$link_destination  = isset( $attributes['linkDestination'] ) ? $attributes['linkDestination'] : 'none';
 	$lightbox_settings = block_core_image_get_lightbox_settings( $block->parsed_block );
 
 	/*
-	 * If the lightbox is enabled and the image is not linked, add the filter
-	 * and the JavaScript view file.
+	 * If the lightbox is enabled and the image is not linked, adds the filter and
+	 * the JavaScript view file.
 	 */
 	if (
 		isset( $lightbox_settings ) &&
@@ -47,15 +47,27 @@ function render_block_core_image( $attributes, $content, $block ) {
 		isset( $lightbox_settings['enabled'] ) &&
 		true === $lightbox_settings['enabled']
 	) {
+		$suffix = wp_scripts_get_suffix();
+		if ( defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN ) {
+			$module_url = gutenberg_url( '/build/interactivity/image.min.js' );
+		}
+
+		wp_register_script_module(
+			'@wordpress/block-library/image',
+			isset( $module_url ) ? $module_url : includes_url( "blocks/image/view{$suffix}.js" ),
+			array( '@wordpress/interactivity' ),
+			defined( 'GUTENBERG_VERSION' ) ? GUTENBERG_VERSION : get_bloginfo( 'version' )
+		);
+
 		wp_enqueue_script_module( '@wordpress/block-library/image' );
 
 		/*
 		 * This render needs to happen in a filter with priority 15 to ensure that
 		 * it runs after the duotone filter and that duotone styles are applied to
 		 * the image in the lightbox. Lightbox has to work with any plugins that
-		 * might use filters as well. Removing this can be considered in the
-		 * future if the way the blocks are rendered changes, or if a
-		 * new kind of filter is introduced.
+		 * might use filters as well. Removing this can be considered in the future
+		 * if the way the blocks are rendered changes, or if a new kind of filter is
+		 * introduced.
 		 */
 		add_filter( 'render_block_core/image', 'block_core_image_render_lightbox', 15, 2 );
 	} else {
@@ -65,7 +77,7 @@ function render_block_core_image( $attributes, $content, $block ) {
 		remove_filter( 'render_block_core/image', 'block_core_image_render_lightbox', 15 );
 	}
 
-	return $processor->get_updated_html();
+	return $p->get_updated_html();
 }
 
 /**
@@ -78,7 +90,7 @@ function render_block_core_image( $attributes, $content, $block ) {
  * @return array Filtered block data.
  */
 function block_core_image_get_lightbox_settings( $block ) {
-	// Get the lightbox setting from the block attributes.
+	// Gets the lightbox setting from the block attributes.
 	if ( isset( $block['attrs']['lightbox'] ) ) {
 		$lightbox_settings = $block['attrs']['lightbox'];
 	}
@@ -89,9 +101,9 @@ function block_core_image_get_lightbox_settings( $block ) {
 		// If not present in global settings, check the top-level global settings.
 		//
 		// NOTE: If no block-level settings are found, the previous call to
-		// `wp_get_global_settings` will return the whole `theme.json`
-		// structure in which case we can check if the "lightbox" key is present at
-		// the top-level of the global settings and use its value.
+		// `wp_get_global_settings` will return the whole `theme.json` structure in
+		// which case we can check if the "lightbox" key is present at the top-level
+		// of the global settings and use its value.
 		if ( isset( $lightbox_settings['lightbox'] ) ) {
 			$lightbox_settings = wp_get_global_settings( array( 'lightbox' ) );
 		}
@@ -110,103 +122,76 @@ function block_core_image_get_lightbox_settings( $block ) {
  */
 function block_core_image_render_lightbox( $block_content, $block ) {
 	/*
-	 * If it's not possible that an IMG element exists then return the given
-	 * block content as-is. It may be that there's no actual image in the block
-	 * or it could be that another plugin already modified this HTML.
+	 * If there's no IMG tag in the block then return the given block content
+	 * as-is. There's nothing that this code can knowingly modify to add the
+	 * lightbox behavior.
 	 */
-	if ( false === stripos( $block_content, '<img' ) ) {
-		return $block_content;
+	$p = new WP_HTML_Tag_Processor( $block_content );
+	if ( $p->next_tag( 'figure' ) ) {
+		$p->set_bookmark( 'figure' );
 	}
-
-	$processor = new WP_HTML_Tag_Processor( $block_content );
-
-	$aria_label = __( 'Enlarge image' );
-
-	/*
-	 * If there's definitely no IMG element in the block then return the given
-	 * block content as-is. There's nothing that this code can knowingly modify
-	 * to add the lightbox behavior.
-	 */
-	if ( ! $processor->next_tag( 'img' ) ) {
+	if ( ! $p->next_tag( 'img' ) ) {
 		return $block_content;
 	}
 
-	$alt_attribute = $processor->get_attribute( 'alt' );
-
-	// An empty alt attribute `alt=""` is valid for decorative images.
-	if ( is_string( $alt_attribute ) ) {
-		$alt_attribute = trim( $alt_attribute );
-	}
+	$alt              = $p->get_attribute( 'alt' );
+	$img_uploaded_src = $p->get_attribute( 'src' );
+	$img_class_names  = $p->get_attribute( 'class' );
+	$img_styles       = $p->get_attribute( 'style' );
+	$img_width        = 'none';
+	$img_height       = 'none';
+	$aria_label       = __( 'Enlarge image' );
 
-	// It only makes sense to append the alt text to the button aria-label when the alt text is non-empty.
-	if ( $alt_attribute ) {
+	if ( $alt ) {
 		/* translators: %s: Image alt text. */
-		$aria_label = sprintf( __( 'Enlarge image: %s' ), $alt_attribute );
+		$aria_label = sprintf( __( 'Enlarge image: %s' ), $alt );
 	}
 
-	// Currently, we are only enabling the zoom animation.
-	$lightbox_animation = 'zoom';
-
-	// Note: We want to store the `src` in the context so we
-	// can set it dynamically when the lightbox is opened.
 	if ( isset( $block['attrs']['id'] ) ) {
 		$img_uploaded_src = wp_get_attachment_url( $block['attrs']['id'] );
 		$img_metadata     = wp_get_attachment_metadata( $block['attrs']['id'] );
 		$img_width        = $img_metadata['width'] ?? 'none';
 		$img_height       = $img_metadata['height'] ?? 'none';
-	} else {
-		$img_uploaded_src = $processor->get_attribute( 'src' );
-		$img_width        = 'none';
-		$img_height       = 'none';
 	}
 
-	if ( isset( $block['attrs']['scale'] ) ) {
-		$scale_attr = $block['attrs']['scale'];
-	} else {
-		$scale_attr = false;
-	}
-
-	$w = new WP_HTML_Tag_Processor( $block_content );
-	$w->next_tag( 'figure' );
-	$w->add_class( 'wp-lightbox-container' );
-	$w->set_attribute( 'data-wp-interactive', '{"namespace":"core/image"}' );
-
-	$w->set_attribute(
+	// Figure.
+	$p->seek( 'figure' );
+	$figure_class_names = $p->get_attribute( 'class' );
+	$figure_styles      = $p->get_attribute( 'style' );
+	$p->add_class( 'wp-lightbox-container' );
+	$p->set_attribute( 'data-wp-interactive', '{"namespace":"core/image"}' );
+	$p->set_attribute(
 		'data-wp-context',
-		sprintf(
-			'{  "imageLoaded": false,
-				"initialized": false,
-				"lightboxEnabled": false,
-				"hideAnimationEnabled": false,
-				"preloadInitialized": false,
-				"lightboxAnimation": "%s",
-				"imageUploadedSrc": "%s",
-				"imageCurrentSrc": "",
-				"targetWidth": "%s",
-				"targetHeight": "%s",
-				"scaleAttr": "%s",
-				"dialogLabel": "%s"
-			}',
-			$lightbox_animation,
-			$img_uploaded_src,
-			$img_width,
-			$img_height,
-			$scale_attr,
-			__( 'Enlarged image' )
+		wp_json_encode(
+			array(
+				'uploadedSrc'      => $img_uploaded_src,
+				'figureClassNames' => $figure_class_names,
+				'figureStyles'     => $figure_styles,
+				'imgClassNames'    => $img_class_names,
+				'imgStyles'        => $img_styles,
+				'targetWidth'      => $img_width,
+				'targetHeight'     => $img_height,
+				'scaleAttr'        => $block['attrs']['scale'] ?? false,
+				'ariaLabel'        => $aria_label,
+				'alt'              => $alt,
+			),
+			JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP
 		)
 	);
-	$w->next_tag( 'img' );
-	$w->set_attribute( 'data-wp-init', 'callbacks.initOriginImage' );
-	$w->set_attribute( 'data-wp-on--load', 'actions.handleLoad' );
-	$w->set_attribute( 'data-wp-watch', 'callbacks.setButtonStyles' );
-	// We need to set an event callback on the `img` specifically
-	// because the `figure` element can also contain a caption, and
-	// we don't want to trigger the lightbox when the caption is clicked.
-	$w->set_attribute( 'data-wp-on--click', 'actions.showLightbox' );
-	$w->set_attribute( 'data-wp-watch--setStylesOnResize', 'callbacks.setStylesOnResize' );
-	$body_content = $w->get_updated_html();
 
-	// Add a button alongside image in the body content.
+	// Image.
+	$p->next_tag( 'img' );
+	$p->set_attribute( 'data-wp-init', 'callbacks.setButtonStyles' );
+	$p->set_attribute( 'data-wp-on--load', 'callbacks.setButtonStyles' );
+	$p->set_attribute( 'data-wp-on-window--resize', 'callbacks.setButtonStyles' );
+	// Sets an event callback on the `img` because the `figure` element can also
+	// contain a caption, and we don't want to trigger the lightbox when the
+	// caption is clicked.
+	$p->set_attribute( 'data-wp-on--click', 'actions.showLightbox' );
+
+	$body_content = $p->get_updated_html();
+
+	// Adds a button alongside image in the body content.
 	$img = null;
 	preg_match( '/<img[^>]+>/', $body_content, $img );
 
@@ -229,46 +214,17 @@ function block_core_image_render_lightbox( $block_content, $block ) {
 
 	$body_content = preg_replace( '/<img[^>]+>/', $button, $body_content );
 
-	// We need both a responsive image and an enlarged image to animate
-	// the zoom seamlessly on slow internet connections; the responsive
-	// image is a copy of the one in the body, which animates immediately
-	// as the lightbox is opened, while the enlarged one is a full-sized
-	// version that will likely still be loading as the animation begins.
-	$m = new WP_HTML_Tag_Processor( $block_content );
-	$m->next_tag( 'figure' );
-	$m->add_class( 'responsive-image' );
-	$m->next_tag( 'img' );
-	// We want to set the 'src' attribute to an empty string in the responsive image
-	// because otherwise, as of this writing, the wp_filter_content_tags() function in
-	// WordPress will automatically add a 'srcset' attribute to the image, which will at
-	// times cause the incorrectly sized image to be loaded in the lightbox on Firefox.
-	// Because of this, we bind the 'src' attribute explicitly the current src to reliably
-	// use the exact same image as in the content when the lightbox is first opened while
-	// we wait for the larger image to load.
-	$m->set_attribute( 'src', '' );
-	$m->set_attribute( 'data-wp-bind--src', 'context.imageCurrentSrc' );
-	$m->set_attribute( 'data-wp-style--object-fit', 'state.lightboxObjectFit' );
-	$initial_image_content = $m->get_updated_html();
+	add_action( 'wp_footer', 'block_core_image_print_lightbox_overlay' );
 
-	$q = new WP_HTML_Tag_Processor( $block_content );
-	$q->next_tag( 'figure' );
-	$q->add_class( 'enlarged-image' );
-	$q->next_tag( 'img' );
+	return $body_content;
+}
 
-	// We set the 'src' attribute to an empty string to prevent the browser from loading the image
-	// on initial page load, then bind the attribute to a selector that returns the full-sized image src when
-	// the lightbox is opened. We could use 'loading=lazy' in combination with the 'hidden' attribute to
-	// accomplish the same behavior, but that approach breaks progressive loading of the image in Safari
-	// and Chrome (see https://github.com/WordPress/gutenberg/pull/52765#issuecomment-1674008151). Until that
-	// is resolved, manually setting the 'src' seems to be the best solution to load the large image on demand.
-	$q->set_attribute( 'src', '' );
-	$q->set_attribute( 'data-wp-bind--src', 'state.enlargedImgSrc' );
-	$q->set_attribute( 'data-wp-style--object-fit', 'state.lightboxObjectFit' );
-	$enlarged_image_content = $q->get_updated_html();
+function block_core_image_print_lightbox_overlay() {
+	$close_button_label = esc_attr__( 'Close' );
 
-	// If the current theme does NOT have a `theme.json`, or the colors are not defined,
-	// we need to set the background color & close button color to some default values
-	// because we can't get them from the Global Styles.
+	// If the current theme does NOT have a `theme.json`, or the colors are not
+	// defined, it needs to set the background color & close button color to some
+	// default values because it can't get them from the Global Styles.
 	$background_color   = '#fff';
 	$close_button_color = '#000';
 	if ( wp_theme_has_theme_json() ) {
@@ -281,35 +237,43 @@ function block_core_image_render_lightbox( $block_content, $block ) {
 		}
 	}
 
-	$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 11.8l6.1-6.3-1-1-6.1 6.2-6.1-6.2-1 1 6.1 6.3-6.5 6.7 1 1 6.5-6.6 6.5 6.6 1-1z"></path></svg>';
-	$close_button_label = esc_attr__( 'Close' );
-
-	$lightbox_html = <<<HTML
-        <div data-wp-body="" class="wp-lightbox-overlay $lightbox_animation"
-            data-wp-bind--role="state.roleAttribute"
-            data-wp-bind--aria-label="state.dialogLabel"
-            data-wp-class--initialized="context.initialized"
-            data-wp-class--active="context.lightboxEnabled"
-            data-wp-class--hideAnimationEnabled="context.hideAnimationEnabled"
-            data-wp-bind--aria-modal="state.ariaModal"
-            data-wp-watch="callbacks.initLightbox"
-            data-wp-on--keydown="actions.handleKeydown"
-            data-wp-on--touchstart="actions.handleTouchStart"
-            data-wp-on--touchmove="actions.handleTouchMove"
-            data-wp-on--touchend="actions.handleTouchEnd"
-            data-wp-on--click="actions.hideLightbox"
-            tabindex="-1"
-            >
-                <button type="button" aria-label="$close_button_label" style="fill: $close_button_color" class="close-button" data-wp-on--click="actions.hideLightbox">
-                    $close_button_icon
-                </button>
-                <div class="lightbox-image-container">$initial_image_content</div>
-                <div class="lightbox-image-container">$enlarged_image_content</div>
-                <div class="scrim" style="background-color: $background_color" aria-hidden="true"></div>
-        </div>
+	echo <<<HTML
+		<div 
+			class="wp-lightbox-overlay zoom"
+			data-wp-interactive='{"namespace":"core/image"}'
+			data-wp-context='{}'
+			data-wp-bind--role="state.roleAttribute"
+			data-wp-bind--aria-label="state.currentImage.ariaLabel"
+			data-wp-bind--aria-modal="state.ariaModal"
+			data-wp-class--active="state.overlayEnabled"
+			data-wp-class--show-closing-animation="state.showClosingAnimation"
+			data-wp-watch="callbacks.setOverlayFocus"
+			data-wp-on--keydown="actions.handleKeydown"
+			data-wp-on--touchstart="actions.handleTouchStart"
+			data-wp-on--touchmove="actions.handleTouchMove"
+			data-wp-on--touchend="actions.handleTouchEnd"
+			data-wp-on--click="actions.hideLightbox"
+			data-wp-on-window--resize="callbacks.setOverlayStyles"
+			data-wp-on-window--scroll="actions.handleScroll"
+			tabindex="-1"
+			>
+				<button type="button" aria-label="$close_button_label" style="fill: $close_button_color" class="close-button">
+					<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 11.8l6.1-6.3-1-1-6.1 6.2-6.1-6.2-1 1 6.1 6.3-6.5 6.7 1 1 6.5-6.6 6.5 6.6 1-1z"></path></svg>
+				</button>
+				<div class="lightbox-image-container">
+					<figure data-wp-bind--class="state.currentImage.figureClassNames" data-wp-bind--style="state.currentImage.figureStyles">
+						<img data-wp-bind--alt="state.currentImage.alt" data-wp-bind--class="state.currentImage.imgClassNames" data-wp-bind--style="state.imgStyles" data-wp-bind--src="state.currentImage.currentSrc">
+					</figure>
+				</div>
+				<div class="lightbox-image-container">
+					<figure data-wp-bind--class="state.currentImage.figureClassNames" data-wp-bind--style="state.currentImage.figureStyles">
+						<img data-wp-bind--alt="state.currentImage.alt" data-wp-bind--class="state.currentImage.imgClassNames" data-wp-bind--style="state.imgStyles" data-wp-bind--src="state.enlargedSrc">
+					</figure>
+				</div>
+				<div class="scrim" style="background-color: $background_color" aria-hidden="true"></div>
+				<style data-wp-text="state.overlayStyles"></style>
+		</div>
 HTML;
-
-	return str_replace( '</figure>', $lightbox_html . '</figure>', $body_content );
 }
 
 /**
@@ -322,12 +286,5 @@ function register_block_core_image() {
 			'render_callback' => 'render_block_core_image',
 		)
 	);
-
-	wp_register_script_module(
-		'@wordpress/block-library/image',
-		defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN ? gutenberg_url( '/build/interactivity/image.min.js' ) : includes_url( 'blocks/image/view.min.js' ),
-		array( '@wordpress/interactivity' ),
-		defined( 'GUTENBERG_VERSION' ) ? GUTENBERG_VERSION : get_bloginfo( 'version' )
-	);
 }
 add_action( 'init', 'register_block_core_image' );

package/src/image/save.js

@@ -11,6 +11,7 @@ import {
 	useBlockProps,
 	__experimentalGetElementClassName,
 	__experimentalGetBorderClassesAndStyles as getBorderClassesAndStyles,
+	__experimentalGetShadowClassesAndStyles as getShadowClassesAndStyles,
 } from '@wordpress/block-editor';
 
 export default function save( { attributes } ) {
@@ -34,6 +35,7 @@ export default function save( { attributes } ) {
 
 	const newRel = ! rel ? undefined : rel;
 	const borderProps = getBorderClassesAndStyles( attributes );
+	const shadowProps = getShadowClassesAndStyles( attributes );
 
 	const classes = classnames( {
 		// All other align classes are handled by block supports.
@@ -58,6 +60,7 @@ export default function save( { attributes } ) {
 			className={ imageClasses || undefined }
 			style={ {
 				...borderProps.style,
+				...shadowProps.style,
 				aspectRatio,
 				objectFit: scale,
 				width,

package/src/image/style.scss

@@ -301,7 +301,7 @@
 			animation: both turn-on-visibility 0.35s;
 		}
 	}
-	&.hideanimationenabled {
+	&.show-closing-animation {
 		&:not(.active) {
 			animation: both turn-off-visibility 0.35s;
 			img {
@@ -327,7 +327,7 @@
 					animation: turn-on-visibility 0.4s forwards;
 				}
 			}
-			&.hideanimationenabled {
+			&.show-closing-animation {
 				&:not(.active) {
 					animation: none;
 					.lightbox-image-container {