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

Timestamp:

06/16/2026 09:48:47 AM (3 months ago)

Author:

jonsurrell

Message:

HTML API: Correct and improve documentation issues.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/12043.

Props jonsurrell, westonruter, dmsnell.
See #64896.

File:

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

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

@@ -214 +214 @@
  * ### Bookmarks
  *
- * While scanning through the input HTMl document it's possible to set
+ * While scanning through the input HTML document it's possible to set
  * a named bookmark when a particular tag is found. Later on, after
  * continuing to scan other tags, it's possible to `seek` to one of
@@ -287 +287 @@
  * For these elements the Tag Processor treats the entire sequence as one,
  * from the opening tag, including its contents, through its closing tag.
- * This means that the it's not possible to match the closing tag for a
+ * This means that it's not possible to match the closing tag for a
  * SCRIPT element unless it's unexpected; the Tag Processor already matched
  * it when it found the opening tag.
@@ -299 +299 @@
  *  - `TITLE` and `TEXTAREA` whose contents are treated as plaintext and then any
  *    character references are decoded. E.g. `1 &lt; 2 < 3` becomes `1 < 2 < 3`.
- *  - `IFRAME`, `NOSCRIPT`, `NOEMBED`, `NOFRAME`, `STYLE` whose contents are treated as
+ *  - `IFRAME`, `NOEMBED`, `NOFRAMES`, `STYLE` whose contents are treated as
  *    raw plaintext and left as-is. E.g. `1 &lt; 2 < 3` remains `1 &lt; 2 < 3`.
  *
@@ -330 +330 @@
  *      target names with an ASCII-representable subset of characters. It also exhibits the
  *      same constraint as with CDATA sections, in that `>` cannot exist within the token
- *      since Processing Instructions do no exist within HTML and their syntax transforms
+ *      since Processing Instructions do not exist within HTML and their syntax transforms
  *      into a bogus comment in the DOM.
  *
@@ -522 +522 @@
          *
          *   - In `QUIRKS_MODE`:
-         *       - CSS class and ID selectors match match in an ASCII case-insensitive manner.
+         *       - CSS class and ID selectors match in an ASCII case-insensitive manner.
          *       - A TABLE start tag `<table>` opens a `TABLE` element as a child of a `P`
          *         element if one is open.
@@ -615 +615 @@
          *
          *     <div id="test">...
-         *     012345678901234
-         *     - token length is 14 - 0 = 14
+         *     0123456789012345
+         *     - token length is 15 - 0 = 15
          *
          *     a <!-- comment --> is a token.
          *     0123456789 123456789 123456789
-         *     - token length is 17 - 2 = 15
+         *     - token length is 18 - 2 = 16
          *
          * @since 6.5.0
@@ -926 +926 @@
          *  - a DOCTYPE declaration.
          *  - a processing instruction, e.g. `<?xml version="1.0" ?>`.
-         *
-         * The Tag Processor currently only supports the tag token.
          *
          * @since 6.5.0
@@ -1074 +1072 @@
                  * Preserve the opening tag pointers, as these will be overwritten
                  * when finding the closing tag. They will be reset after finding
-                 * the closing to tag to point to the opening of the special atomic
+                 * the closing tag to point to the opening of the special atomic
                  * tag sequence.
                  */
@@ -1150 +1148 @@
          *
          *     $processor = new WP_HTML_Tag_Processor( '<input type="text" value="Th' );
-         *     false      === $processor->get_next_tag();
+         *     false      === $processor->next_tag();
          *     true       === $processor->paused_at_incomplete_token();
          *
@@ -2526 +2524 @@
                  * at later string indices in the input document.
                  *
-                 * Sorting avoid making out-of-order replacements which
+                 * Sorting avoids making out-of-order replacements which
                  * can lead to mangled output, partially-duplicated
                  * attributes, and overwritten attributes.
@@ -3562 +3560 @@
          *     false === $processor->subdivide_text_appropriately();
          *
-         *     $processor = new WP_HTML_Tag_Processor( "&#x13; \r\n\tMore" );
-         *     true  === $processor->next_token();                   // Text is "␤ ␤␉More".
-         *     true  === $processor->subdivide_text_appropriately(); // Text is "␤ ␤␉".
+         *     $processor = new WP_HTML_Tag_Processor( "&#xD; \r\n\tMore" );
+         *     true  === $processor->next_token();                   // Text is "␍ ␊␉More".
+         *     true  === $processor->subdivide_text_appropriately(); // Text is "␍ ␊␉".
          *     true  === $processor->next_token();                   // Text is "More".
          *     false === $processor->subdivide_text_appropriately();
@@ -4942 +4940 @@
          *
          * Funky comments are tag closers with invalid tag names. Note
-         * that in HTML these are turn into bogus comments. Nonetheless,
+         * that in HTML these are turned into bogus comments. Nonetheless,
          * the Tag Processor recognizes them in a stream of HTML and
          * exposes them for inspection and modification.