Changeset 57507 for trunk/src/wp-includes/html-api/class-wp-html-processor.php

Timestamp:

02/01/2024 12:41:40 AM (8 months 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:

• trunk/src/wp-includes/html-api/class-wp-html-processor.php (modified) (4 diffs)

trunk/src/wp-includes/html-api/class-wp-html-processor.php

@@ -432 +432 @@
 
         if ( '#tag' === $this->get_token_type() ) {
-            $this->step( self::REPROCESS_CURRENT_NODE );
+            $this->step( self::PROCESS_CURRENT_NODE );
         }
 
@@ -514 +514 @@
         }
 
-        if ( self::PROCESS_NEXT_NODE === $node_to_process ) {
+        if ( self::REPROCESS_CURRENT_NODE !== $node_to_process ) {
             /*
              * Void elements still hop onto the stack of open elements even though
@@ -533 +533 @@
                 $this->state->stack_of_open_elements->pop();
             }
-
+        }
+
+        if ( self::PROCESS_NEXT_NODE === $node_to_process ) {
             while ( parent::next_token() && '#tag' !== $this->get_token_type() ) {
                 continue;
@@ -1783 +1785 @@
 
     /**
+     * Indicates that the current HTML token should be processed without advancing the parser.
+     *
+     * @since 6.5.0
+     *
+     * @var string
+     */
+    const PROCESS_CURRENT_NODE = 'process-current-node';
+
+    /**
      * Indicates that the parser encountered unsupported markup and has bailed.
      *