Changeset 57578 for trunk/src/wp-includes/blocks/gallery.php

Timestamp:

02/09/2024 06:20:12 PM (11 months ago)

Author:

youknowriad

Message:

Editor: Update the WordPress packages to Gutenberg 17.7RC1.

This brings the latest and greatest from Gutenberg.
The full changelog is available here
​https://github.com/WordPress/gutenberg/releases/tag/v17.7.0-rc.1

Props youknowriad, get_dave.
See #60315.

File:

• trunk/src/wp-includes/blocks/gallery.php (modified) (3 diffs)

trunk/src/wp-includes/blocks/gallery.php

@@ -34 +34 @@
 
 /**
- * Filter to randomize the order of image blocks.
- *
- * @param array $parsed_block The block being rendered.
- * @return array The block object with randomized order of image blocks.
- */
-function block_core_gallery_random_order( $parsed_block ) {
-    if ( 'core/gallery' === $parsed_block['blockName'] && ! empty( $parsed_block['attrs']['randomOrder'] ) ) {
-        shuffle( $parsed_block['innerBlocks'] );
-    }
-    return $parsed_block;
-}
-
-add_filter( 'render_block_data', 'block_core_gallery_random_order' );
-
-/**
- * Adds a style tag for the --wp--style--unstable-gallery-gap var.
- *
- * The Gallery block needs to recalculate Image block width based on
- * the current gap setting in order to maintain the number of flex columns
- * so a css var is added to allow this.
+ * Renders the `core/gallery` block on the server.
  *
  * @param array  $attributes Attributes of the block being rendered.
@@ -60 +41 @@
  */
 function block_core_gallery_render( $attributes, $content ) {
+    // Adds a style tag for the --wp--style--unstable-gallery-gap var.
+    // The Gallery block needs to recalculate Image block width based on
+    // the current gap setting in order to maintain the number of flex columns
+    // so a css var is added to allow this.
+
     $gap = $attributes['style']['spacing']['blockGap'] ?? null;
     // Skip if gap value contains unsupported characters.
@@ -131 +117 @@
         )
     );
-    return (string) $processed_content;
+
+    // The WP_HTML_Tag_Processor class calls get_updated_html() internally
+    // when the instance is treated as a string, but here we explicitly
+    // convert it to a string.
+    $updated_content = $processed_content->get_updated_html();
+
+    /*
+     * Randomize the order of image blocks. Ideally we should shuffle
+     * the `$parsed_block['innerBlocks']` via the `render_block_data` hook.
+     * However, this hook doesn't apply inner block updates when blocks are
+     * nested.
+     * @todo: In the future, if this hook supports updating innerBlocks in
+     * nested blocks, it should be refactored.
+     *
+     * @see: https://github.com/WordPress/gutenberg/pull/58733
+     */
+    if ( empty( $attributes['randomOrder'] ) ) {
+        return $updated_content;
+    }
+
+    // This pattern matches figure elements with the `wp-block-image` class to
+    // avoid the gallery's wrapping `figure` element and extract images only.
+    $pattern = '/<figure[^>]*\bwp-block-image\b[^>]*>.*?<\/figure>/';
+
+    // Find all Image blocks.
+    preg_match_all( $pattern, $updated_content, $matches );
+    if ( ! $matches ) {
+        return $updated_content;
+    }
+    $image_blocks = $matches[0];
+
+    // Randomize the order of Image blocks.
+    shuffle( $image_blocks );
+    $i       = 0;
+    $content = preg_replace_callback(
+        $pattern,
+        static function () use ( $image_blocks, &$i ) {
+            $new_image_block = $image_blocks[ $i ];
+            ++$i;
+            return $new_image_block;
+        },
+        $updated_content
+    );
+
+    return $content;
 }
 /**