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

Timestamp:

11/06/2024 07:22:22 PM (23 months ago)

Author:

westonruter

Message:

HTML API: Improve private method name used by WP_HTML_Processor::next_token().

This renames the private _next_token method to next_visitable_token. It also removes irrelevant assertions from the unit test.

Follow-up to [59285].

Props dmsnell, jonsurrell, westonruter.
See #62269.

File:

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

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

@@ -617 +617 @@
          */
         public function next_token(): bool {
-                return $this->_next_token();
+                return $this->next_visitable_token();
         }
 
@@ -628 +628 @@
          * WP_HTML_Tag_Processor instead.
          *
-         * @since 6.7.1 Added for internal support; do not use.
+         * Note that this method may call itself recursively. This is why it is not
+         * implemented as {@see WP_HTML_Processor::next_token()}, which instead calls
+         * this method similarly to how {@see WP_HTML_Tag_Processor::next_token()}
+         * calls the {@see WP_HTML_Tag_Processor::base_class_next_token()} method.
+         *
+         * @since 6.7.1 Added for internal support.
          *
          * @access private
@@ -634 +639 @@
          * @return bool
          */
-        private function _next_token(): bool {
+        private function next_visitable_token(): bool {
                 $this->current_element = null;
 
@@ -652 +657 @@
                  */
                 if ( empty( $this->element_queue ) && $this->step() ) {
-                        return $this->_next_token();
+                        return $this->next_visitable_token();
                 }
 
@@ -663 +668 @@
                         }
 
-                        return empty( $this->element_queue ) ? false : $this->_next_token();
+                        return empty( $this->element_queue ) ? false : $this->next_visitable_token();
                 }
 
@@ -674 +679 @@
                  */
                 if ( 'root-node' === $this->current_element->token->bookmark_name ) {
-                        return $this->_next_token();
+                        return $this->next_visitable_token();
                 }
 
@@ -686 +691 @@
                 // Avoid sending close events for elements which don't expect a closing.
                 if ( $is_pop && ! $this->expects_closer( $this->current_element->token ) ) {
-                        return $this->_next_token();
+                        return $this->next_visitable_token();
                 }