Changeset 58590

Timestamp:

06/28/2024 07:11:25 AM (3 months ago)

Author:

gziolo

Message:

HTML API: Report breadcrumbs properly when visiting virtual nodes.

The breadcrumbs have been updated to account for the virtual nodes
and the depth method has been updated to rely on the fixed breadcrumb logic.

Reviewed by jonsurrell, zieladam, gziolo.
Merges [58588] to the 6.6 branch.

Follow-up to [58304].

Props dmsnell, hellofromtonya, joemcgill, jonsurrell, zieladam.
Fixes #61348.

Location:

branches/6.6

Files:

• . (modified) (1 prop)
• src/wp-includes/html-api/class-wp-html-open-elements.php (modified) (3 diffs)
• src/wp-includes/html-api/class-wp-html-processor.php (modified) (4 diffs)

branches/6.6/src/wp-includes/html-api/class-wp-html-open-elements.php

@@ -309 +309 @@
     public function pop() {
         $item = array_pop( $this->stack );
-
         if ( null === $item ) {
             return false;
         }
 
+        if ( 'context-node' === $item->bookmark_name ) {
+            $this->stack[] = $item;
+            return false;
+        }
+
         $this->after_element_pop( $item );
         return true;
@@ -330 +334 @@
     public function pop_until( $tag_name ) {
         foreach ( $this->walk_up() as $item ) {
+            if ( 'context-node' === $item->bookmark_name ) {
+                return true;
+            }
+
             $this->pop();
 
@@ -370 +378 @@
      */
     public function remove_node( $token ) {
+        if ( 'context-node' === $token->bookmark_name ) {
+            return false;
+        }
+
         foreach ( $this->walk_up() as $position_from_end => $item ) {
             if ( $token->bookmark_name !== $item->bookmark_name ) {

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

@@ -520 +520 @@
         }
 
-        if ( 0 === count( $this->element_queue ) && ! $this->step() ) {
-            while ( $this->state->stack_of_open_elements->pop() ) {
+        if ( 'done' !== $this->has_seen_context_node && 0 === count( $this->element_queue ) && ! $this->step() ) {
+            while ( 'context-node' !== $this->state->stack_of_open_elements->current_node()->bookmark_name && $this->state->stack_of_open_elements->pop() ) {
                 continue;
             }
+            $this->has_seen_context_node = 'done';
+            return $this->next_token();
         }
 
@@ -538 +540 @@
 
         if ( ! isset( $this->current_element ) ) {
-            return $this->next_token();
+            if ( 'done' === $this->has_seen_context_node ) {
+                return false;
+            } else {
+                return $this->next_token();
+            }
         }
 
@@ -783 +789 @@
      * @since 6.4.0
      *
-     * @todo make aware of queue of elements, because stack operations have already been done by now.
-     *
      * @return string[]|null Array of tag names representing path to matched node, if matched, otherwise NULL.
      */
     public function get_breadcrumbs() {
         $breadcrumbs = array();
+
         foreach ( $this->state->stack_of_open_elements->walk_down() as $stack_item ) {
             $breadcrumbs[] = $stack_item->node_name;
+        }
+
+        if ( ! $this->is_virtual() ) {
+            return $breadcrumbs;
+        }
+
+        foreach ( $this->element_queue as $queue_item ) {
+            if ( $this->current_element->token->bookmark_name === $queue_item->token->bookmark_name ) {
+                break;
+            }
+
+            if ( 'context-node' === $queue_item->token->bookmark_name ) {
+                break;
+            }
+
+            if ( 'real' === $queue_item->provenance ) {
+                break;
+            }
+
+            if ( WP_HTML_Stack_Event::PUSH === $queue_item->operation ) {
+                $breadcrumbs[] = $queue_item->token->node_name;
+            } else {
+                array_pop( $breadcrumbs );
+            }
+        }
+
+        if ( null !== parent::get_token_name() && ! parent::is_tag_closer() ) {
+            array_pop( $breadcrumbs );
+        }
+
+        // Add the virtual node we're at.
+        if ( WP_HTML_Stack_Event::PUSH === $this->current_element->operation ) {
+            $breadcrumbs[] = $this->current_element->token->node_name;
         }
 
@@ -822 +860 @@
      */
     public function get_current_depth() {
-        return $this->state->stack_of_open_elements->count();
+        return $this->is_virtual()
+            ? count( $this->get_breadcrumbs() )
+            : $this->state->stack_of_open_elements->count();
     }