Changeset 56994

Timestamp:

10/24/2023 08:49:38 AM (14 months ago)

Author:

Bernhard Reiter

Message:

Blocks: Fix layout support to be compatible with enhanced pagination.

Make layout support compatible with enhanced pagination by ensuring that generated class names are stable across pagination, even when the number of rendered posts is different.

With the previous implementation of enhanced pagination, the CSS corresponding to each block was not detected. Therefore, for enhanced pagination to work correctly, the CSS of the blocks present in the Post Template must be stable on all pages.

The number of posts rendered by the Query block is always the same, except in the last page, where it can be only a fraction. If any of the blocks rendered by the Post Template used the wp_unique_id function, the ID (which is incremental) would have been different than in the previous pages and the class names would have varied.

This is remediated by this changeset by replacing the usage of wp_unique_id in the layout support (which is used by the Query block) with an implementation that uses IDs that are incremental only for that block. That way, the generated class names are never affected by the number of times wp_unique_id runs.

Props luisherranz, andrewserong, isabel_brison, costdev, mukesh27, cbravobernal, hellofromTonya, jorbin.
Fixes #59681.

Location:

trunk

Files:

• src/wp-includes/block-supports/layout.php (modified) (1 diff)
• src/wp-includes/functions.php (modified) (1 diff)
• tests/phpunit/tests/blocks/render.php (modified) (1 diff)
• tests/phpunit/tests/functions/wpUniquePrefixedId.php (added)

trunk/src/wp-includes/block-supports/layout.php

@@ -631 +631 @@
     $class_names        = array();
     $layout_definitions = wp_get_layout_definitions();
-    $container_class    = wp_unique_id( 'wp-container-' );
+
+    /*
+     * Uses an incremental ID that is independent per prefix to make sure that
+     * rendering different numbers of blocks doesn't affect the IDs of other
+     * blocks. Makes the CSS class names stable across paginations
+     * for features like the enhanced pagination of the Query block.
+     */
+    $container_class = wp_unique_prefixed_id(
+        'wp-container-' . sanitize_title( $block['blockName'] ) . '-layout-'
+    );
 
     // Set the correct layout type for blocks using legacy content width.

trunk/src/wp-includes/functions.php

@@ -7832 +7832 @@
 
 /**
+ * Generates an incremental ID that is independent per each different prefix.
+ *
+ * It is similar to `wp_unique_id`, but each prefix has its own internal ID
+ * counter to make each prefix independent from each other. The ID starts at 1
+ * and increments on each call. The returned value is not universally unique,
+ * but it is unique across the life of the PHP process and it's stable per
+ * prefix.
+ *
+ * @since 6.4.0
+ *
+ * @param string $prefix Optional. Prefix for the returned ID. Default empty string.
+ * @return string Incremental ID per prefix.
+ */
+function wp_unique_prefixed_id( $prefix = '' ) {
+    static $id_counters = array();
+
+    if ( ! is_string( $prefix ) ) {
+        wp_trigger_error(
+            __FUNCTION__,
+            sprintf( 'The prefix must be a string. "%s" data type given.', gettype( $prefix ) )
+        );
+        $prefix = '';
+    }
+
+    if ( ! isset( $id_counters[ $prefix ] ) ) {
+        $id_counters[ $prefix ] = 0;
+    }
+
+    $id = ++$id_counters[ $prefix ];
+
+    return $prefix . (string) $id;
+}
+
+/**
  * Gets last changed date for the specified cache group.
  *

trunk/tests/phpunit/tests/blocks/render.php

@@ -219 +219 @@
         $html = do_blocks( self::strip_r( file_get_contents( $html_path ) ) );
         // If blocks opt into Gutenberg's layout implementation
-        // the container will receive an added classname of `wp_unique_id( 'wp-container-' )`
+        // the container will receive an additional, unique classname based on "wp-container-[blockname]-layout"
         // so we need to normalize the random id.
-        $normalized_html = preg_replace( '/wp-container-\d+/', 'wp-container-1', $html );
+        $normalized_html = preg_replace( '/wp-container-[a-z-]+\d+/', 'wp-container-1', $html );
 
         // The gallery block uses a unique class name of `wp_unique_id( 'wp-block-gallery-' )`