Changeset 57582

Timestamp:

02/10/2024 10:52:28 PM (3 years ago)

Author:

dmsnell

Message:

HTML API: Add subclassed has_bookmark() and fix seek()

The WP_HTML_Processor::has_bookmark() method has not correctly reported bookmarks
which have been set, because it wraps the given bookmark names when setting them.
Additionally, WP_HTML_Processor::seek() does not seek to correct location if HTML
has been updated because it wasn't flushing enqueued updates to the document.

In this patch both problems are resolved and added tests guard these behaviors
against future regressions.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/6039
Discussed in https://core.trac.wordpress.org/ticket/60474

Follow-up to [56274].
Props dmsnell, jonsurrell.
Fixes #60474.

File:

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

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

@@ -1238 +1238 @@
          */
         public function seek( $bookmark_name ) {
+                // Flush any pending updates to the document before beginning.
+                $this->get_updated_html();
+
                 $actual_bookmark_name = "_{$bookmark_name}";
                 $processor_started_at = $this->state->current_token
@@ -1247 +1250 @@
                 switch ( $direction ) {
                         case 'forward':
-                                // When moving forwards, re-parse the document until reaching the same location as the original bookmark.
+                                // When moving forwards, reparse the document until reaching the same location as the original bookmark.
                                 while ( $this->step() ) {
                                         if ( $bookmark_starts_at === $this->bookmarks[ $this->state->current_token->bookmark_name ]->start ) {
@@ -1367 +1370 @@
         public function set_bookmark( $bookmark_name ) {
                 return parent::set_bookmark( "_{$bookmark_name}" );
+        }
+
+        /**
+         * Checks whether a bookmark with the given name exists.
+         *
+         * @since 6.5.0
+         *
+         * @param string $bookmark_name Name to identify a bookmark that potentially exists.
+         * @return bool Whether that bookmark exists.
+         */
+        public function has_bookmark( $bookmark_name ) {
+                return parent::has_bookmark( "_{$bookmark_name}" );
         }