Changeset 51674

Timestamp:

08/26/2021 07:09:16 PM (3 years ago)

Author:

desrosj

Message:

Editor: Ensure block attribute serialization in PHP matches the JavaScript equivalent.

The serializeAttributes() function in JavaScript uses JSON.stringify, which does not encode slashes and unicode characters by default. This resulted in the PHP serialization through json_encode() producing different results.

This also switches from json_encode() to wp_json_encode() to prevent failures when any non UTF-8 characters are included.

Props kevinfodness, SergeyBiryukov, timothyblynjacobs.
Fixes #53936.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (2 diffs)
• tests/phpunit/tests/blocks/serialize.php (modified) (1 diff)

trunk/src/wp-includes/blocks.php

@@ -489 +489 @@
  * the result in an HTML comment.
  *
+ * This function must produce output that remains in sync with the output of
+ * the serializeAttributes JavaScript function in the block editor in order
+ * to ensure consistent operation between PHP and JavaScript.
+ *
  * @since 5.3.1
  *
@@ -495 +499 @@
  */
 function serialize_block_attributes( $block_attributes ) {
-    $encoded_attributes = json_encode( $block_attributes );
+    $encoded_attributes = wp_json_encode( $block_attributes, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE );
     $encoded_attributes = preg_replace( '/--/', '\\u002d\\u002d', $encoded_attributes );
     $encoded_attributes = preg_replace( '/</', '\\u003c', $encoded_attributes );

trunk/tests/phpunit/tests/blocks/serialize.php

@@ -48 +48 @@
             // Block with attribute values that may conflict with HTML comment.
             array( '<!-- wp:attributes {"key":"\\u002d\\u002d\\u003c\\u003e\\u0026\\u0022"} /-->' ),
+
+            // Block with attribute values that should not be escaped.
+            array( '<!-- wp:attributes {"key":"€1.00 / 3 for €2.00"} /-->' ),
         );
     }