Context Navigation

← Previous Change
Next Change →

wpHtmlProcessor.php

Timestamp:

02/01/2024 12:41:40 AM (2 years ago)

Author:

dmsnell

Message:

HTML API: Fix void tag nesting with next_token

When next_token() was introduced, it introduced a regression in the HTML
Processor whereby void tags remain on the stack of open elements when they
shouldn't. This led to invalid values returned from get_breadcrumbs().

The reason was that calling next_token() works through a different code path
than the HTML Processor runs everything else. To solve this, its sub-classed
next_token() called step( self::REPROCESS_CURRENT_TOKEN ) so that the proper
HTML accounting takes place.

Unfortunately that same reprocessing code path skipped the step whereby void
and self-closing elements are popped from the stack of open elements.

In this patch, that step is run with a third mode for step(), which is the
new self::PROCESS_CURRENT_TOKEN. This mode acts as if self::PROCESS_NEXT_NODE
were called, except it doesn't advance the parser.

Developed in https://github.com/WordPress/wordpress-develop/pull/5975
Discussed in https://core.trac.wordpress.org/ticket/60382

Follow-up to [57348]

Props dmsnell, jonsurrell
Fixes #60382

File:

: 1 edited

trunk/tests/phpunit/tests/html-api/wpHtmlProcessor.php (modified) (1 diff)

Legend:

: Unmodified
: Added
: Removed

trunk/tests/phpunit/tests/html-api/wpHtmlProcessor.php

-              r57343
+              r57507
                 $this->assertTrue(
                         $processor->next_tag(),
+                        'Should have found the DIV as the second tag.'
+                );
+                $this->assertSame(
+                        array( 'HTML', 'BODY', 'DIV' ),
+                        $processor->get_breadcrumbs(),
+                        "DIV should have been a sibling of the {$tag_name}."
+                );
+        }
+        /**
+         * Ensure non-nesting tags do not nest when processing tokens.
+         *
+         * @ticket 60382
+         *
+         * @dataProvider data_void_tags
+         *
+         * @param string $tag_name Name of void tag under test.
+         */
+        public function test_cannot_nest_void_tags_next_token( $tag_name ) {
+                $processor = WP_HTML_Processor::create_fragment( "<{$tag_name}><div>" );
+                /*
+                 * This HTML represents the same as the following HTML,
+                 * assuming that it were provided `<img>` as the tag:
+                 *
+                 *     <html>
+                 *         <body>
+                 *             <img>
+                 *             <div></div>
+                 *         </body>
+                 *     </html>
+                 */
+                $found_tag = $processor->next_token();
+                if ( WP_HTML_Processor::ERROR_UNSUPPORTED === $processor->get_last_error() ) {
+                        $this->markTestSkipped( "Tag {$tag_name} is not supported." );
+                }
+                $this->assertTrue(
+                        $found_tag,
+                        "Could not find first {$tag_name}."
+                );
+                $this->assertSame(
+                        array( 'HTML', 'BODY', $tag_name ),
+                        $processor->get_breadcrumbs(),
+                        'Found incorrect nesting of first element.'
+                );
+                $this->assertTrue(
+                        $processor->next_token(),
                         'Should have found the DIV as the second tag.'
                 );

Note: See TracChangeset for help on using the changeset viewer.

Make WordPress Core

Context Navigation

Changeset 57507 for trunk/tests/phpunit/tests/html-api/wpHtmlProcessor.php

Legend:

trunk/tests/phpunit/tests/html-api/wpHtmlProcessor.php

Download in other formats: