Changeset 55662

Timestamp:

04/20/2023 09:11:06 AM (3 years ago)

Author:

Bernhard Reiter

Message:

HTML API: Ensure attribute updates happen only once for case variants.

When setting a new value for an attribute multiple times and providing
multiple case variations of the attribute name the Tag Processor has
been appending multiple copies of the attribute into the updated HTML.

This means that only the first attribute set determines the value in
the final output, plus the output will appear wrong.

In this patch we're adding a test to catch the situation and resolving it
by using the appropriate comparable attribute name as a key for storing
the updates as we go. Previously we stored updates to the attribute by
its given $name, but when a new update of the same name with a
case variant was queued, it would not override the previously-enqueued
value as it out to have.

Props dmsnell, zieladam.
Merges [55659] to the 6.2 branch.
Fixes #58146.

Location:

branches/6.2

Files:

• src/wp-includes/html-api/class-wp-html-tag-processor.php (modified) (2 diffs)
• tests/phpunit/tests/html-api/wpHtmlTagProcessor.php (modified) (1 diff)

branches/6.2/src/wp-includes/html-api/class-wp-html-tag-processor.php

@@ -1776 +1776 @@
      *
      * @since 6.2.0
+     * @since 6.2.1 Fix: Only create a single update for multiple calls with case-variant attribute names.
      *
      * @param string      $name  The attribute name to target.
@@ -1868 +1869 @@
              *    Result: <div id="new"/>
              */
-            $existing_attribute             = $this->attributes[ $comparable_name ];
-            $this->lexical_updates[ $name ] = new WP_HTML_Text_Replacement(
+            $existing_attribute = $this->attributes[ $comparable_name ];
+            $this->lexical_updates[ $comparable_name ] = new WP_HTML_Text_Replacement(
                 $existing_attribute->start,
                 $existing_attribute->end,

branches/6.2/tests/phpunit/tests/html-api/wpHtmlTagProcessor.php

@@ -911 +911 @@
             'Existing attribute was not updated'
         );
+    }
+
+    /**
+     * Ensures that when setting an attribute multiple times that only
+     * one update flushes out into the updated HTML.
+     *
+     * @ticket 58146
+     *
+     * @covers WP_HTML_Tag_Processor::set_attribute
+     */
+    public function test_set_attribute_with_case_variants_updates_only_the_original_first_copy() {
+        $p = new WP_HTML_Tag_Processor( '<div data-enabled="5">' );
+        $p->next_tag();
+        $p->set_attribute( 'DATA-ENABLED', 'canary' );
+        $p->set_attribute( 'Data-Enabled', 'canary' );
+        $p->set_attribute( 'dATa-EnABled', 'canary' );
+
+        $this->assertSame( '<div data-enabled="canary">', strtolower( $p->get_updated_html() ) );
     }