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

Timestamp:

08/23/2024 02:53:59 PM (2 years ago)

Author:

dmsnell

Message:

HTML API: Parse DOCTYPE tokens and set HTML parser mode accordingly.

This patch adds until-now missing code to parse the structure of HTML DOCTYPE declarations. The DOCTYPE is mostly unused but can dictate the document compatability mode, which governs whether CSS class names match in a ASCII-case-insensitive way or not, and whether TABLE elements close an open P element.

The DOCTYPE information is made available through a new method on the Tag Processor, get_doctype_info().

Developed in ​https://github.com/wordpress/wordpress-develop/pull/7195
Discussed in https://core.trac.wordpress.org/ticket/61576

Props dmsnell, jonsurrell.
See #61576.

File:

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

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

@@ -4028 +4028 @@
 
         /**
+         * Gets DOCTYPE declaration info from a DOCTYPE token.
+         *
+         * DOCTYPE tokens may appear in many places in an HTML document. In most places, they are
+         * simply ignored. The main parsing functions find the basic shape of DOCTYPE tokens but
+         * do not perform detailed parsing.
+         *
+         * This method can be called to perform a full parse of the DOCTYPE token and retrieve
+         * its information.
+         *
+         * @return WP_HTML_Doctype_Info|null The DOCTYPE declaration information or `null` if not
+         *                                   currently at a DOCTYPE node.
+         */
+        public function get_doctype_info(): ?WP_HTML_Doctype_Info {
+                if ( self::STATE_DOCTYPE !== $this->parser_state ) {
+                        return null;
+                }
+
+                return WP_HTML_Doctype_Info::from_doctype_token( substr( $this->html, $this->token_starts_at, $this->token_length ) );
+        }
+
+        /**
          * Parser Ready State.
          *
@@ -4118 +4139 @@
         /**
          * Indicates that the parser has found a DOCTYPE node and it's
-         * possible to read and modify its modifiable text.
+         * possible to read its DOCTYPE information via `get_doctype_info()`.
          *
          * @since 6.5.0