Changeset 58951

Timestamp:

08/29/2024 05:39:22 AM (3 months ago)

Author:

ramonopoly

Message:

Block Styles: Ensure unique classname generation for variations

This commit simplifies block style variation class name generation to ensure unique class names by replacing the hashing of block attributes in the block style variation class names with a call to wp_unique_id.

Doing so avoids potential for non-unique class names and conflicting styles when exact copies of a block are inserted via a repeated pattern.

Props aaronrobertshaw, martinkrcho, mukesh27, peterwilsoncc, ramonopoly.

Fixes #61877.

Location:

trunk

Files:

• src/wp-includes/block-supports/block-style-variations.php (modified) (3 diffs)
• src/wp-includes/deprecated.php (modified) (1 diff)
• tests/phpunit/tests/block-supports/wpCreateBlockStyleVariationInstanceName.php (modified) (1 diff)

trunk/src/wp-includes/block-supports/block-style-variations.php

@@ -7 +7 @@
  * @since 6.6.0
  */
-
-/**
- * Generate block style variation instance name.
- *
- * @since 6.6.0
- * @access private
- *
- * @param array  $block     Block object.
- * @param string $variation Slug for the block style variation.
- *
- * @return string The unique variation name.
- */
-function wp_create_block_style_variation_instance_name( $block, $variation ) {
-    return $variation . '--' . md5( serialize( $block ) );
-}
 
 /**
@@ -125 +110 @@
     wp_resolve_block_style_variation_ref_values( $variation_data, $theme_json );
 
-    $variation_instance = wp_create_block_style_variation_instance_name( $parsed_block, $variation );
+    $variation_instance = wp_unique_id( $variation . '--' );
     $class_name         = "is-style-$variation_instance";
     $updated_class_name = $parsed_block['attrs']['className'] . " $class_name";
@@ -231 +216 @@
     /*
      * Matches a class prefixed by `is-style`, followed by the
-     * variation slug, then `--`, and finally a hash.
-     *
-     * See `wp_create_block_style_variation_instance_name` for class generation.
-     */
-    preg_match( '/\bis-style-(\S+?--\w+)\b/', $block['attrs']['className'], $matches );
+     * variation slug, then `--`, and finally an instance number.
+     */
+    preg_match( '/\bis-style-(\S+?--\d+)\b/', $block['attrs']['className'], $matches );
 
     if ( empty( $matches ) ) {

trunk/src/wp-includes/deprecated.php

@@ -6388 +6388 @@
     }
 }
+
+/**
+ * Generate block style variation instance name.
+ *
+ * @since 6.6.0
+ * @deprecated 6.7.0 Use `wp_unique_id( $variation . '--' )` instead.
+ *
+ * @access private
+ *
+ * @param array  $block     Block object.
+ * @param string $variation Slug for the block style variation.
+ *
+ * @return string The unique variation name.
+ */
+function wp_create_block_style_variation_instance_name( $block, $variation ) {
+    _deprecated_function( __FUNCTION__, '6.7.0', 'wp_unique_id' );
+    return $variation . '--' . md5( serialize( $block ) );
+}

trunk/tests/phpunit/tests/block-supports/wpCreateBlockStyleVariationInstanceName.php

@@ -14 +14 @@
      *
      * @covers ::wp_create_block_style_variation_instance_name
+     *
+     * @expectedDeprecated wp_create_block_style_variation_instance_name
      */
     public function test_block_style_variation_instance_name_generation() {