<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56274] trunk: HTML-API: Introduce minimal HTML Processor.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/56274">56274</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/56274","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>Bernhard Reiter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-07-20 13:41:21 +0000 (Thu, 20 Jul 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>HTML-API: Introduce minimal HTML Processor.
This patch introduces the //first// of //many// iterations on the evolution of the HTML API, the HTML Processor, which is built in order to understand HTML structure including nesting, misnesting, and complicated semantic rules.
In the first iteration, the HTML Processor is arbitrarily limited to a minimal subset of functionality so that we can review it, ship it, test it, and collect feedback before moving forward. This means that this patch is more or less an extension to the Tag Processor query language, providing the ability not only to scan for a tag of a given name, but also to find an HTML element in a specific nesting path.
The HTML Processor also aborts any time it encounters:
- a tag that isn't a `P`, `DIV`, `FIGURE`, `FIGCAPTION`, `IMG`, `STRONG`, `B`, `EM`, `I`, `A`, `BIG`, `CODE`, `FONT`, `SMALL`, `STRIKE`, `TT`, or `U` tag. this limit exists because many HTML elements require specific rules and we are trying to limit the number of rules introduced at once. this work is targeted at existing work in places like the image block.
- certain misnesting constructs that evoke complicated resolution inside the HTML spec. where possible and where simple to do reliably, certain parse errors are handled. in most cases the HTML Processor aborts.
The structure of the HTML Processor is established in this patch. Further spec-compliance comes through filling out //more of the same// kind and nature of code as is found in this patch. Certain critical HTML algorithms are partially supported, and where support requires more than is present, the HTML Processor acknowledges this and refuses to operate.
In this patch are explorations for how to verify that new HTML support is fully added (instead of allowing for partial updates that leave some code paths non-compliant). Performance is hard to measure since support is so limited at the current time, but it should generally follow the performance of the Tag Processor somewhat close as the overhead is minimized as much as practical.
Props dmsnell, zieladam, costdev.
Fixes <a href="https://core.trac.wordpress.org/ticket/58517">#58517</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeshtmlapiclasswphtmltagprocessorphp">trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php</a></li>
<li><a href="#trunksrcwpsettingsphp">trunk/src/wp-settings.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeshtmlapiclasswphtmlactiveformattingelementsphp">trunk/src/wp-includes/html-api/class-wp-html-active-formatting-elements.php</a></li>
<li><a href="#trunksrcwpincludeshtmlapiclasswphtmlopenelementsphp">trunk/src/wp-includes/html-api/class-wp-html-open-elements.php</a></li>
<li><a href="#trunksrcwpincludeshtmlapiclasswphtmlprocessorstatephp">trunk/src/wp-includes/html-api/class-wp-html-processor-state.php</a></li>
<li><a href="#trunksrcwpincludeshtmlapiclasswphtmlprocessorphp">trunk/src/wp-includes/html-api/class-wp-html-processor.php</a></li>
<li><a href="#trunksrcwpincludeshtmlapiclasswphtmltokenphp">trunk/src/wp-includes/html-api/class-wp-html-token.php</a></li>
<li><a href="#trunksrcwpincludeshtmlapiclasswphtmlunsupportedexceptionphp">trunk/src/wp-includes/html-api/class-wp-html-unsupported-exception.php</a></li>
<li><a href="#trunktestsphpunittestshtmlapiwpHtmlProcessorphp">trunk/tests/phpunit/tests/html-api/wpHtmlProcessor.php</a></li>
<li><a href="#trunktestsphpunittestshtmlapiwpHtmlProcessorBreadcrumbsphp">trunk/tests/phpunit/tests/html-api/wpHtmlProcessorBreadcrumbs.php</a></li>
<li><a href="#trunktestsphpunittestshtmlapiwpHtmlSupportRequiredOpenElementsphp">trunk/tests/phpunit/tests/html-api/wpHtmlSupportRequiredOpenElements.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludeshtmlapiclasswphtmlactiveformattingelementsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/html-api/class-wp-html-active-formatting-elements.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/html-api/class-wp-html-active-formatting-elements.php (rev 0)
+++ trunk/src/wp-includes/html-api/class-wp-html-active-formatting-elements.php 2023-07-20 13:41:21 UTC (rev 56274)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,188 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * HTML API: WP_HTML_Active_Formatting_Elements class
+ *
+ * @package WordPress
+ * @subpackage HTML-API
+ * @since 6.4.0
+ */
+
+/**
+ * Core class used by the HTML processor during HTML parsing
+ * for managing the stack of active formatting elements.
+ *
+ * This class is designed for internal use by the HTML processor.
+ *
+ * > Initially, the list of active formatting elements is empty.
+ * > It is used to handle mis-nested formatting element tags.
+ * >
+ * > The list contains elements in the formatting category, and markers.
+ * > The markers are inserted when entering applet, object, marquee,
+ * > template, td, th, and caption elements, and are used to prevent
+ * > formatting from "leaking" into applet, object, marquee, template,
+ * > td, th, and caption elements.
+ * >
+ * > In addition, each element in the list of active formatting elements
+ * > is associated with the token for which it was created, so that
+ * > further elements can be created for that token if necessary.
+ *
+ * @since 6.4.0
+ *
+ * @access private
+ *
+ * @see https://html.spec.whatwg.org/#list-of-active-formatting-elements
+ * @see WP_HTML_Processor
+ */
+class WP_HTML_Active_Formatting_Elements {
+ /**
+ * Holds the stack of active formatting element references.
+ *
+ * @since 6.4.0
+ *
+ * @var WP_HTML_Token[]
+ */
+ private $stack = array();
+
+ /**
+ * Reports if a specific node is in the stack of active formatting elements.
+ *
+ * @since 6.4.0
+ *
+ * @param WP_HTML_Token $token Look for this node in the stack.
+ * @return bool Whether the referenced node is in the stack of active formatting elements.
+ *
+ */
+ public function contains_node( $token ) {
+ foreach ( $this->walk_up() as $item ) {
+ if ( $token->bookmark_name === $item->bookmark_name ) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Returns how many nodes are currently in the stack of active formatting elements.
+ *
+ * @since 6.4.0
+ *
+ * @return int How many node are in the stack of active formatting elements.
+ */
+ public function count() {
+ return count( $this->stack );
+ }
+
+ /**
+ * Returns the node at the end of the stack of active formatting elements,
+ * if one exists. If the stack is empty, returns null.
+ *
+ * @since 6.4.0
+ *
+ * @return WP_HTML_Token|null Last node in the stack of active formatting elements, if one exists, otherwise null.
+ */
+ public function current_node() {
+ $current_node = end( $this->stack );
+
+ return $current_node ? $current_node : null;
+ }
+
+ /**
+ * Pushes a node onto the stack of active formatting elements.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#push-onto-the-list-of-active-formatting-elements
+ *
+ * @param WP_HTML_Token $token Push this node onto the stack.
+ */
+ public function push( $token ) {
+ /*
+ * > If there are already three elements in the list of active formatting elements after the last marker,
+ * > if any, or anywhere in the list if there are no markers, that have the same tag name, namespace, and
+ * > attributes as element, then remove the earliest such element from the list of active formatting
+ * > elements. For these purposes, the attributes must be compared as they were when the elements were
+ * > created by the parser; two elements have the same attributes if all their parsed attributes can be
+ * > paired such that the two attributes in each pair have identical names, namespaces, and values
+ * > (the order of the attributes does not matter).
+ *
+ * @TODO: Implement the "Noah's Ark clause" to only add up to three of any given kind of formatting elements to the stack.
+ */
+ // > Add element to the list of active formatting elements.
+ $this->stack[] = $token;
+ }
+
+ /**
+ * Removes a node from the stack of active formatting elements.
+ *
+ * @since 6.4.0
+ *
+ * @param WP_HTML_Token $token Remove this node from the stack, if it's there already.
+ * @return bool Whether the node was found and removed from the stack of active formatting elements.
+ */
+ public function remove_node( $token ) {
+ foreach ( $this->walk_up() as $position_from_end => $item ) {
+ if ( $token->bookmark_name !== $item->bookmark_name ) {
+ continue;
+ }
+
+ $position_from_start = $this->count() - $position_from_end - 1;
+ array_splice( $this->stack, $position_from_start, 1 );
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Steps through the stack of active formatting elements, starting with the
+ * top element (added first) and walking downwards to the one added last.
+ *
+ * This generator function is designed to be used inside a "foreach" loop.
+ *
+ * Example:
+ *
+ * $html = '<em><strong><a>We are here';
+ * foreach ( $stack->walk_down() as $node ) {
+ * echo "{$node->node_name} -> ";
+ * }
+ * > EM -> STRONG -> A ->
+ *
+ * To start with the most-recently added element and walk towards the top,
+ * @see WP_HTML_Active_Formatting_Elements::walk_up
+ *
+ * @since 6.4.0
+ */
+ public function walk_down() {
+ $count = count( $this->stack );
+
+ for ( $i = 0; $i < $count; $i++ ) {
+ yield $this->stack[ $i ];
+ }
+ }
+
+ /**
+ * Steps through the stack of active formatting elements, starting with the
+ * bottom element (added last) and walking upwards to the one added first.
+ *
+ * This generator function is designed to be used inside a "foreach" loop.
+ *
+ * Example:
+ *
+ * $html = '<em><strong><a>We are here';
+ * foreach ( $stack->walk_up() as $node ) {
+ * echo "{$node->node_name} -> ";
+ * }
+ * > A -> STRONG -> EM ->
+ *
+ * To start with the first added element and walk towards the bottom,
+ * @see WP_HTML_Active_Formatting_Elements::walk_down
+ *
+ * @since 6.4.0
+ */
+ public function walk_up() {
+ for ( $i = count( $this->stack ) - 1; $i >= 0; $i-- ) {
+ yield $this->stack[ $i ];
+ }
+ }
+}
</ins></span></pre></div>
<a id="trunksrcwpincludeshtmlapiclasswphtmlopenelementsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/html-api/class-wp-html-open-elements.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/html-api/class-wp-html-open-elements.php (rev 0)
+++ trunk/src/wp-includes/html-api/class-wp-html-open-elements.php 2023-07-20 13:41:21 UTC (rev 56274)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,413 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * HTML API: WP_HTML_Open_Elements class
+ *
+ * @package WordPress
+ * @subpackage HTML-API
+ * @since 6.4.0
+ */
+
+/**
+ * Core class used by the HTML processor during HTML parsing
+ * for managing the stack of open elements.
+ *
+ * This class is designed for internal use by the HTML processor.
+ *
+ * > Initially, the stack of open elements is empty. The stack grows
+ * > downwards; the topmost node on the stack is the first one added
+ * > to the stack, and the bottommost node of the stack is the most
+ * > recently added node in the stack (notwithstanding when the stack
+ * > is manipulated in a random access fashion as part of the handling
+ * > for misnested tags).
+ *
+ * @since 6.4.0
+ *
+ * @access private
+ *
+ * @see https://html.spec.whatwg.org/#stack-of-open-elements
+ * @see WP_HTML_Processor
+ */
+class WP_HTML_Open_Elements {
+ /**
+ * Holds the stack of open element references.
+ *
+ * @since 6.4.0
+ *
+ * @var WP_HTML_Token[]
+ */
+ public $stack = array();
+
+ /**
+ * Whether a P element is in button scope currently.
+ *
+ * This class optimizes scope lookup by pre-calculating
+ * this value when elements are added and removed to the
+ * stack of open elements which might change its value.
+ * This avoids frequent iteration over the stack.
+ *
+ * @since 6.4.0
+ *
+ * @var bool
+ */
+ private $has_p_in_button_scope = false;
+
+ /**
+ * Reports if a specific node is in the stack of open elements.
+ *
+ * @since 6.4.0
+ *
+ * @param WP_HTML_Token $token Look for this node in the stack.
+ * @return bool Whether the referenced node is in the stack of open elements.
+ */
+ public function contains_node( $token ) {
+ foreach ( $this->walk_up() as $item ) {
+ if ( $token->bookmark_name === $item->bookmark_name ) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Returns how many nodes are currently in the stack of open elements.
+ *
+ * @since 6.4.0
+ *
+ * @return int How many node are in the stack of open elements.
+ */
+ public function count() {
+ return count( $this->stack );
+ }
+
+ /**
+ * Returns the node at the end of the stack of open elements,
+ * if one exists. If the stack is empty, returns null.
+ *
+ * @since 6.4.0
+ *
+ * @return WP_HTML_Token|null Last node in the stack of open elements, if one exists, otherwise null.
+ */
+ public function current_node() {
+ $current_node = end( $this->stack );
+
+ return $current_node ? $current_node : null;
+ }
+
+ /**
+ * Returns whether an element is in a specific scope.
+ *
+ * ## HTML Support
+ *
+ * This function skips checking for the termination list because there
+ * are no supported elements which appear in the termination list.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#has-an-element-in-the-specific-scope
+ *
+ * @param string $tag_name Name of tag check.
+ * @param string[] $termination_list List of elements that terminate the search.
+ * @return bool Whether the element was found in a specific scope.
+ */
+ public function has_element_in_specific_scope( $tag_name, $termination_list ) {
+ foreach ( $this->walk_up() as $node ) {
+ if ( $node->node_name === $tag_name ) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Returns whether a particular element is in scope.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#has-an-element-in-scope
+ *
+ * @param string $tag_name Name of tag to check.
+ * @return bool Whether given element is in scope.
+ */
+ public function has_element_in_scope( $tag_name ) {
+ return $this->has_element_in_specific_scope(
+ $tag_name,
+ array(
+ /*
+ * Because it's not currently possible to encounter
+ * one of the termination elements, they don't need
+ * to be listed here. If they were, they would be
+ * unreachable and only waste CPU cycles while
+ * scanning through HTML.
+ */
+ )
+ );
+ }
+
+ /**
+ * Returns whether a particular element is in list item scope.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#has-an-element-in-list-item-scope
+ *
+ * @param string $tag_name Name of tag to check.
+ * @return bool Whether given element is in scope.
+ */
+ public function has_element_in_list_item_scope( $tag_name ) {
+ throw new WP_HTML_Unsupported_Exception( 'Cannot process elements depending on list item scope.' );
+ }
+
+ /**
+ * Returns whether a particular element is in button scope.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#has-an-element-in-button-scope
+ *
+ * @param string $tag_name Name of tag to check.
+ * @return bool Whether given element is in scope.
+ */
+ public function has_element_in_button_scope( $tag_name ) {
+ return $this->has_element_in_specific_scope(
+ $tag_name,
+ array(
+ /*
+ * Because it's not currently possible to encounter
+ * one of the termination elements, they don't need
+ * to be listed here. If they were, they would be
+ * unreachable and only waste CPU cycles while
+ * scanning through HTML.
+ */
+ )
+ );
+ }
+
+ /**
+ * Returns whether a particular element is in table scope.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#has-an-element-in-table-scope
+ *
+ * @param string $tag_name Name of tag to check.
+ * @return bool Whether given element is in scope.
+ */
+ public function has_element_in_table_scope( $tag_name ) {
+ throw new WP_HTML_Unsupported_Exception( 'Cannot process elements depending on table scope.' );
+ }
+
+ /**
+ * Returns whether a particular element is in select scope.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#has-an-element-in-select-scope
+ *
+ * @param string $tag_name Name of tag to check.
+ * @return bool Whether given element is in scope.
+ */
+ public function has_element_in_select_scope( $tag_name ) {
+ throw new WP_HTML_Unsupported_Exception( 'Cannot process elements depending on select scope.' );
+ }
+
+ /**
+ * Returns whether a P is in BUTTON scope.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#has-an-element-in-button-scope
+ *
+ * @return bool
+ */
+ public function has_p_in_button_scope() {
+ return $this->has_p_in_button_scope;
+ }
+
+ /**
+ * Pops a node off of the stack of open elements.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#stack-of-open-elements
+ *
+ * @return bool Whether a node was popped off of the stack.
+ */
+ public function pop() {
+ $item = array_pop( $this->stack );
+
+ if ( null === $item ) {
+ return false;
+ }
+
+ $this->after_element_pop( $item );
+ return true;
+ }
+
+ /**
+ * Pops nodes off of the stack of open elements until one with the given tag name has been popped.
+ *
+ * @since 6.4.0
+ *
+ * @see WP_HTML_Open_Elements::pop
+ *
+ * @param string $tag_name Name of tag that needs to be popped off of the stack of open elements.
+ * @return bool Whether a tag of the given name was found and popped off of the stack of open elements.
+ */
+ public function pop_until( $tag_name ) {
+ foreach ( $this->walk_up() as $item ) {
+ $this->pop();
+
+ if ( $tag_name === $item->node_name ) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Pushes a node onto the stack of open elements.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#stack-of-open-elements
+ *
+ * @param WP_HTML_Token $stack_item Item to add onto stack.
+ */
+ public function push( $stack_item ) {
+ $this->stack[] = $stack_item;
+ $this->after_element_push( $stack_item );
+ }
+
+ /**
+ * Removes a specific node from the stack of open elements.
+ *
+ * @since 6.4.0
+ *
+ * @param WP_HTML_Token $token The node to remove from the stack of open elements.
+ * @return bool Whether the node was found and removed from the stack of open elements.
+ */
+ public function remove_node( $token ) {
+ foreach ( $this->walk_up() as $position_from_end => $item ) {
+ if ( $token->bookmark_name !== $item->bookmark_name ) {
+ continue;
+ }
+
+ $position_from_start = $this->count() - $position_from_end - 1;
+ array_splice( $this->stack, $position_from_start, 1 );
+ $this->after_element_pop( $item );
+ return true;
+ }
+
+ return false;
+ }
+
+
+ /**
+ * Steps through the stack of open elements, starting with the top element
+ * (added first) and walking downwards to the one added last.
+ *
+ * This generator function is designed to be used inside a "foreach" loop.
+ *
+ * Example:
+ *
+ * $html = '<em><strong><a>We are here';
+ * foreach ( $stack->walk_down() as $node ) {
+ * echo "{$node->node_name} -> ";
+ * }
+ * > EM -> STRONG -> A ->
+ *
+ * To start with the most-recently added element and walk towards the top,
+ * @see WP_HTML_Open_Elements::walk_up
+ *
+ * @since 6.4.0
+ */
+ public function walk_down() {
+ $count = count( $this->stack );
+
+ for ( $i = 0; $i < $count; $i++ ) {
+ yield $this->stack[ $i ];
+ }
+ }
+
+ /**
+ * Steps through the stack of open elements, starting with the bottom element
+ * (added last) and walking upwards to the one added first.
+ *
+ * This generator function is designed to be used inside a "foreach" loop.
+ *
+ * Example:
+ *
+ * $html = '<em><strong><a>We are here';
+ * foreach ( $stack->walk_up() as $node ) {
+ * echo "{$node->node_name} -> ";
+ * }
+ * > A -> STRONG -> EM ->
+ *
+ * To start with the first added element and walk towards the bottom,
+ * @see WP_HTML_Open_Elements::walk_down
+ *
+ * @since 6.4.0
+ */
+ public function walk_up() {
+ for ( $i = count( $this->stack ) - 1; $i >= 0; $i-- ) {
+ yield $this->stack[ $i ];
+ }
+ }
+
+ /*
+ * Internal helpers.
+ */
+
+ /**
+ * Updates internal flags after adding an element.
+ *
+ * Certain conditions (such as "has_p_in_button_scope") are maintained here as
+ * flags that are only modified when adding and removing elements. This allows
+ * the HTML Processor to quickly check for these conditions instead of iterating
+ * over the open stack elements upon each new tag it encounters. These flags,
+ * however, need to be maintained as items are added and removed from the stack.
+ *
+ * @since 6.4.0
+ *
+ * @param WP_HTML_Token $item Element that was added to the stack of open elements.
+ */
+ public function after_element_push( $item ) {
+ /*
+ * When adding support for new elements, expand this switch to trap
+ * cases where the precalculated value needs to change.
+ */
+ switch ( $item->node_name ) {
+ case 'P':
+ $this->has_p_in_button_scope = true;
+ break;
+ }
+ }
+
+ /**
+ * Updates internal flags after removing an element.
+ *
+ * Certain conditions (such as "has_p_in_button_scope") are maintained here as
+ * flags that are only modified when adding and removing elements. This allows
+ * the HTML Processor to quickly check for these conditions instead of iterating
+ * over the open stack elements upon each new tag it encounters. These flags,
+ * however, need to be maintained as items are added and removed from the stack.
+ *
+ * @since 6.4.0
+ *
+ * @param WP_HTML_Token $item Element that was removed from the stack of open elements.
+ */
+ public function after_element_pop( $item ) {
+ /*
+ * When adding support for new elements, expand this switch to trap
+ * cases where the precalculated value needs to change.
+ */
+ switch ( $item->node_name ) {
+ case 'P':
+ $this->has_p_in_button_scope = $this->has_element_in_button_scope( 'P' );
+ break;
+ }
+ }
+}
</ins></span></pre></div>
<a id="trunksrcwpincludeshtmlapiclasswphtmlprocessorstatephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/html-api/class-wp-html-processor-state.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/html-api/class-wp-html-processor-state.php (rev 0)
+++ trunk/src/wp-includes/html-api/class-wp-html-processor-state.php 2023-07-20 13:41:21 UTC (rev 56274)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,121 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * HTML API: WP_HTML_Processor_State class
+ *
+ * @package WordPress
+ * @subpackage HTML-API
+ * @since 6.4.0
+ */
+
+/**
+ * Core class used by the HTML processor during HTML parsing
+ * for managing the internal parsing state.
+ *
+ * This class is designed for internal use by the HTML processor.
+ *
+ * @since 6.4.0
+ *
+ * @access private
+ *
+ * @see WP_HTML_Processor
+ */
+class WP_HTML_Processor_State {
+ /*
+ * Insertion mode constants.
+ *
+ * These constants exist and are named to make it easier to
+ * discover and recognize the supported insertion modes in
+ * the parser.
+ *
+ * Out of all the possible insertion modes, only those
+ * supported by the parser are listed here. As support
+ * is added to the parser for more modes, add them here
+ * following the same naming and value pattern.
+ *
+ * @see https://html.spec.whatwg.org/#the-insertion-mode
+ */
+
+ /**
+ * Initial insertion mode for full HTML parser.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#the-initial-insertion-mode
+ * @see WP_HTML_Processor_State::$insertion_mode
+ *
+ * @var string
+ */
+ const INSERTION_MODE_INITIAL = 'insertion-mode-initial';
+
+ /**
+ * In body insertion mode for full HTML parser.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#parsing-main-inbody
+ * @see WP_HTML_Processor_State::$insertion_mode
+ *
+ * @var string
+ */
+ const INSERTION_MODE_IN_BODY = 'insertion-mode-in-body';
+
+ /**
+ * Tracks open elements while scanning HTML.
+ *
+ * This property is initialized in the constructor and never null.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#stack-of-open-elements
+ *
+ * @var WP_HTML_Open_Elements
+ */
+ public $stack_of_open_elements = null;
+
+ /**
+ * Tracks open formatting elements, used to handle mis-nested formatting element tags.
+ *
+ * This property is initialized in the constructor and never null.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#list-of-active-formatting-elements
+ *
+ * @var WP_HTML_Active_Formatting_Elements
+ */
+ public $active_formatting_elements = null;
+
+ /**
+ * Tree construction insertion mode.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#insertion-mode
+ *
+ * @var string
+ */
+ public $insertion_mode = self::INSERTION_MODE_INITIAL;
+
+ /**
+ * Context node initializing fragment parser, if created as a fragment parser.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#concept-frag-parse-context
+ *
+ * @var [string, array]|null
+ */
+ public $context_node = null;
+
+ /**
+ * Constructor - creates a new and empty state value.
+ *
+ * @since 6.4.0
+ *
+ * @see WP_HTML_Processor
+ */
+ public function __construct() {
+ $this->stack_of_open_elements = new WP_HTML_Open_Elements();
+ $this->active_formatting_elements = new WP_HTML_Active_Formatting_Elements();
+ }
+}
</ins></span></pre></div>
<a id="trunksrcwpincludeshtmlapiclasswphtmlprocessorphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/html-api/class-wp-html-processor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/html-api/class-wp-html-processor.php (rev 0)
+++ trunk/src/wp-includes/html-api/class-wp-html-processor.php 2023-07-20 13:41:21 UTC (rev 56274)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,1266 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * HTML API: WP_HTML_Processor class
+ *
+ * @package WordPress
+ * @subpackage HTML-API
+ * @since 6.4.0
+ */
+
+/**
+ * Core class used to safely parse and modify an HTML document.
+ *
+ * The HTML Processor class properly parses and modifies HTML5 documents.
+ *
+ * It supports a subset of the HTML5 specification, and when it encounters
+ * unsupported markup, it aborts early to avoid unintentionally breaking
+ * the document. The HTML Processor should never break an HTML document.
+ *
+ * While the {@see WP_HTML_Tag_Processor} is a valuable tool for modifying
+ * attributes on individual HTML tags, the HTML Processor is more capable
+ * and useful for the following operations:
+ *
+ * - Querying based on nested HTML structure.
+ *
+ * Eventually the HTML Processor will also support:
+ * - Wrapping a tag in surrounding HTML.
+ * - Unwrapping a tag by removing its parent.
+ * - Inserting and removing nodes.
+ * - Reading and changing inner content.
+ *
+ * ## Usage
+ *
+ * Use of this class requires three steps:
+ *
+ * 1. Call a static creator method with your input HTML document.
+ * 2. Find the location in the document you are looking for.
+ * 3. Request changes to the document at that location.
+ *
+ * Example:
+ *
+ * $processor = WP_HTML_Processor::createFragment( $html );
+ * if ( $processor->next_tag( array( 'breadcrumbs' => array( 'DIV', 'FIGURE', 'IMG' ) ) ) ) {
+ * $processor->add_class( 'responsive-image' );
+ * }
+ *
+ * #### Breadcrumbs
+ *
+ * Breadcrumbs represent the stack of open elements from the root
+ * of the document or fragment down to the currently-matched node,
+ * if one is currently selected. Call {@see WP_HTML_Processor::get_breadcrumbs}
+ * to inspect the breadcrumbs for a matched tag.
+ *
+ * Breadcrumbs can specify nested HTML structure and are equivalent
+ * to a CSS selector comprising tag names separated by the child
+ * combinator, such as "DIV > FIGURE > IMG".
+ *
+ * Since all elements find themselves inside a full HTML document
+ * when parsed, the return value from `get_breadcrumbs()` will always
+ * contain any implicit outermost elements. For example, when parsing
+ * with `createFragment()` in the `BODY` context (the default), any
+ * tag in the given HTML document will contain `array( 'HTML', 'BODY', … )`
+ * in its breadcrumbs.
+ *
+ * Despite containing the implied outermost elements in their breadcrumbs,
+ * tags may be found with the shortest-matching breadcrumb query. That is,
+ * `array( 'IMG' )` matches all IMG elements and `array( 'P', 'IMG' )`
+ * matches all IMG elements directly inside a P element. To ensure that no
+ * partial matches erroneously match it's possible to specify in a query
+ * the full breadcrumb match.
+ *
+ * Example:
+ *
+ * $html = '<figure><img><figcaption>A <em>lovely</em> day outside</figcaption></figure>';
+ * // ----- Matches here.
+ * $processor->next_tag( array( 'breadcrumbs' => array( 'FIGURE', 'IMG' ) ) );
+ *
+ * $html = '<figure><img><figcaption>A <em>lovely</em> day outside</figcaption></figure>';
+ * // ---- Matches here.
+ * $processor->next_tag( array( 'breadcrumbs' => array( 'FIGURE', 'IMG', 'FIGCAPTION', 'EM' ) ) );
+ *
+ * $html = '<div><img></div><img>';
+ * // ----- Matches here, because IMG must be a direct child of the implicit BODY.
+ * $processor->next_tag( array( 'breadcrumbs' => array( 'BODY', 'IMG' ) ) );
+ *
+ * ## HTML Support
+ *
+ * This class implements a small part of the HTML5 specification.
+ * It's designed to operate within its support and abort early whenever
+ * encountering circumstances it can't properly handle. This is
+ * the principle way in which this class remains as simple as possible
+ * without cutting corners and breaking compliance.
+ *
+ * ### Supported elements
+ *
+ * If any unsupported element appears in the HTML input the HTML Processor
+ * will abort early and stop all processing. This draconian measure ensures
+ * that the HTML Processor won't break any HTML it doesn't fully understand.
+ *
+ * The following list specifies the HTML tags that _are_ supported:
+ *
+ * - Links: A.
+ * - The formatting elements: B, BIG, CODE, EM, FONT, I, SMALL, STRIKE, STRONG, TT, U.
+ * - Containers: DIV, FIGCAPTION, FIGURE.
+ * - Paragraph: P.
+ * - Void elements: IMG.
+ *
+ * ### Supported markup
+ *
+ * Some kinds of non-normative HTML involve reconstruction of formatting elements and
+ * re-parenting of mis-nested elements. For example, a DIV tag found inside a TABLE
+ * may in fact belong _before_ the table in the DOM. If the HTML Processor encounters
+ * such a case it will stop processing.
+ *
+ * The following list specifies HTML markup that _is_ supported:
+ *
+ * - Markup involving only those tags listed above.
+ * - Fully-balanced and non-overlapping tags.
+ * - HTML with unexpected tag closers.
+ * - P tags after unclosed P tags.
+ * - A tags after unclosed A tags that don't involve any active formatting elements.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/
+ */
+class WP_HTML_Processor extends WP_HTML_Tag_Processor {
+ /**
+ * HTML processing requires more bookmarks than basic tag processing.
+ *
+ * @since 6.4.0
+ *
+ * @var int
+ */
+ const MAX_BOOKMARKS = 100;
+
+ /**
+ * Static query for instructing the Tag Processor to visit every token.
+ *
+ * @since 6.4.0
+ *
+ * @var array
+ */
+ const VISIT_EVERYTHING = array( 'tag_closers' => 'visit' );
+
+ /**
+ * Holds the working state of the parser, including the stack of
+ * open elements and the stack of active formatting elements.
+ *
+ * Initialized in the constructor.
+ *
+ * @since 6.4.0
+ *
+ * @var WP_HTML_Processor_State
+ */
+ private $state = null;
+
+ /**
+ * Used to create unique bookmark names.
+ *
+ * @since 6.4.0
+ *
+ * @var int
+ */
+ private $bookmark_counter = 0;
+
+ /**
+ * Refers to the currently-matched tag, if any.
+ *
+ * @since 6.4.0
+ *
+ * @var WP_HTML_Token|null
+ */
+ private $current_token = null;
+
+ /**
+ * Stores an explanation for why something failed, if it did.
+ *
+ * @see self::get_last_error
+ *
+ * @since 6.4.0
+ *
+ * @var string|null
+ */
+ private $last_error = null;
+
+ /**
+ * Releases a bookmark when PHP garbage-collects its wrapping WP_HTML_Token instance.
+ *
+ * This function is created inside the class constructor so that it can be passed to
+ * the stack of open elements and the stack of active formatting elements without
+ * exposing it as a public method on the class.
+ *
+ * @since 6.4.0
+ *
+ * @var closure
+ */
+ private $release_internal_bookmark = null;
+
+ /*
+ * Public Interface Functions
+ */
+
+ /**
+ * Creates an HTML processor in the fragment parsing mode.
+ *
+ * Use this for cases where you are processing chunks of HTML that
+ * will be found within a bigger HTML document, such as rendered
+ * block output that exists within a post, `the_content` inside a
+ * rendered site layout.
+ *
+ * Fragment parsing occurs within a context, which is an HTML element
+ * that the document will eventually be placed in. It becomes important
+ * when special elements have different rules than others, such as inside
+ * a TEXTAREA or a TITLE tag where things that look like tags are text,
+ * or inside a SCRIPT tag where things that look like HTML syntax are JS.
+ *
+ * The context value should be a representation of the tag into which the
+ * HTML is found. For most cases this will be the body element. The HTML
+ * form is provided because a context element may have attributes that
+ * impact the parse, such as with a SCRIPT tag and its `type` attribute.
+ *
+ * ## Current HTML Support
+ *
+ * - The only supported context is `<body>`, which is the default value.
+ * - The only supported document encoding is `UTF-8`, which is the default value.
+ *
+ * @since 6.4.0
+ *
+ * @param string $html Input HTML fragment to process.
+ * @param string $context Context element for the fragment, must be default of `<body>`.
+ * @param string $encoding Text encoding of the document; must be default of 'UTF-8'.
+ * @return WP_HTML_Processor|null The created processor if successful, otherwise null.
+ */
+ public static function createFragment( $html, $context = '<body>', $encoding = 'UTF-8' ) {
+ if ( '<body>' !== $context ) {
+ return null;
+ }
+
+ $p = new self( $html, self::CONSTRUCTOR_UNLOCK_CODE );
+ $p->state->context_node = array( 'BODY', array() );
+ $p->state->insertion_mode = WP_HTML_Processor_State::INSERTION_MODE_IN_BODY;
+
+ // @TODO: Create "fake" bookmarks for non-existent but implied nodes.
+ $p->bookmarks['root-node'] = new WP_HTML_Span( 0, 0 );
+ $p->bookmarks['context-node'] = new WP_HTML_Span( 0, 0 );
+
+ $p->state->stack_of_open_elements->push(
+ new WP_HTML_Token(
+ 'root-node',
+ 'HTML',
+ false
+ )
+ );
+
+ $p->state->stack_of_open_elements->push(
+ new WP_HTML_Token(
+ 'context-node',
+ $p->state->context_node[0],
+ false
+ )
+ );
+
+ return $p;
+ }
+
+ /**
+ * Constructor.
+ *
+ * @access private
+ *
+ * @since 6.4.0
+ *
+ * @param string $html HTML to process.
+ * @param string|null $use_the_static_create_methods_instead This constructor should not be called manually.
+ */
+ public function __construct( $html, $use_the_static_create_methods_instead = null ) {
+ parent::__construct( $html );
+
+ if ( self::CONSTRUCTOR_UNLOCK_CODE !== $use_the_static_create_methods_instead ) {
+ _doing_it_wrong(
+ __METHOD__,
+ sprintf(
+ /* translators: %s: WP_HTML_Processor::createFragment. */
+ __( 'Call %s to create an HTML Processor instead of calling the constructor directly.' ),
+ '<code>WP_HTML_Processor::createFragment</code>'
+ ),
+ '6.4.0'
+ );
+ }
+
+ $this->state = new WP_HTML_Processor_State();
+
+ /*
+ * Create this wrapper so that it's possible to pass
+ * a private method into WP_HTML_Token classes without
+ * exposing it to any public API.
+ */
+ $this->release_internal_bookmark = function ( $name ) {
+ parent::release_bookmark( $name );
+ };
+ }
+
+ /**
+ * Returns the last error, if any.
+ *
+ * Various situations lead to parsing failure but this class will
+ * return `false` in all those cases. To determine why something
+ * failed it's possible to request the last error. This can be
+ * helpful to know if it's possible to fix something or to give up.
+ *
+ * Example
+ *
+ * $p = WP_HTML_Processor::createFragment( '<template><strong><button><em><p><em>' );
+ * false === $p->next_tag();
+ * WP_HTML_Processor::ERROR_UNSUPPORTED === $p->get_last_error();
+ *
+ * @since 6.4.0
+ *
+ * @see self::ERROR_UNSUPPORTED
+ * @see self::ERROR_EXCEEDED_MAX_BOOKMARKS
+ *
+ * @return string|null The last error, if one exists, otherwise null.
+ */
+ public function get_last_error() {
+ return $this->last_error;
+ }
+
+ /**
+ * Finds the next tag matching the $query.
+ *
+ * @TODO: Support matching the class name and tag name.
+ *
+ * @since 6.4.0
+ *
+ * @throws WP_HTML_Unsupported_Exception
+ *
+ * @param array|string|null $query {
+ * Optional. Which tag name to find, having which class, etc. Default is to find any tag.
+ *
+ * @type string|null $tag_name Which tag to find, or `null` for "any tag."
+ * @type int|null $match_offset Find the Nth tag matching all search criteria.
+ * 1 for "first" tag, 3 for "third," etc.
+ * Defaults to first tag.
+ * @type string|null $class_name Tag must contain this whole class name to match.
+ * @type string[] $breadcrumbs DOM sub-path at which element is found, e.g. `array( 'FIGURE', 'IMG' )`.
+ * }
+ * @return bool Whether a tag was matched.
+ */
+ public function next_tag( $query = null ) {
+ if ( null === $query ) {
+ return $this->step();
+ }
+
+ if ( is_string( $query ) ) {
+ $query = array( 'breadcrumbs' => array( $query ) );
+ }
+
+ if ( ! is_array( $query ) ) {
+ _doing_it_wrong(
+ __METHOD__,
+ __( 'Please pass a query array to this function.' ),
+ '6.4.0'
+ );
+ return false;
+ }
+
+ if ( ! ( array_key_exists( 'breadcrumbs', $query ) && is_array( $query['breadcrumbs'] ) ) ) {
+ return $this->step();
+ }
+
+ if ( isset( $query['tag_closers'] ) && 'visit' === $query['tag_closers'] ) {
+ _doing_it_wrong(
+ __METHOD__,
+ __( 'Cannot visit tag closers in HTML Processor.' ),
+ '6.4.0'
+ );
+ return false;
+ }
+
+ $breadcrumbs = $query['breadcrumbs'];
+ $match_offset = isset( $query['match_offset'] ) ? (int) $query['match_offset'] : 1;
+
+ $crumb = end( $breadcrumbs );
+ $target = strtoupper( $crumb );
+ while ( $this->step() ) {
+ if ( $target !== $this->get_tag() ) {
+ continue;
+ }
+
+ // Look up the stack to see if the breadcrumbs match.
+ foreach ( $this->state->stack_of_open_elements->walk_up() as $node ) {
+ if ( strtoupper( $crumb ) !== $node->node_name ) {
+ break;
+ }
+
+ $crumb = prev( $breadcrumbs );
+ if ( false === $crumb && 0 === --$match_offset ) {
+ return true;
+ }
+ }
+
+ $crumb = end( $breadcrumbs );
+ }
+
+ return false;
+ }
+
+ /**
+ * Steps through the HTML document and stop at the next tag, if any.
+ *
+ * @since 6.4.0
+ *
+ * @throws Exception
+ *
+ * @see self::PROCESS_NEXT_NODE
+ * @see self::REPROCESS_CURRENT_NODE
+ *
+ * @param string $node_to_process Whether to parse the next node or reprocess the current node.
+ * @return bool Whether a tag was matched.
+ */
+ public function step( $node_to_process = self::PROCESS_NEXT_NODE ) {
+ if ( self::PROCESS_NEXT_NODE === $node_to_process ) {
+ $top_node = $this->state->stack_of_open_elements->current_node();
+ if ( $top_node && self::is_void( $top_node->node_name ) ) {
+ $this->state->stack_of_open_elements->pop();
+ }
+
+ parent::next_tag( self::VISIT_EVERYTHING );
+ }
+
+ // Finish stepping when there are no more tokens in the document.
+ if ( null === $this->get_tag() ) {
+ return false;
+ }
+
+ $this->current_token = new WP_HTML_Token(
+ $this->bookmark_tag(),
+ $this->get_tag(),
+ $this->is_tag_closer(),
+ $this->release_internal_bookmark
+ );
+
+ try {
+ switch ( $this->state->insertion_mode ) {
+ case WP_HTML_Processor_State::INSERTION_MODE_IN_BODY:
+ return $this->step_in_body();
+
+ default:
+ $this->last_error = self::ERROR_UNSUPPORTED;
+ throw new WP_HTML_Unsupported_Exception( 'Cannot parse outside of the IN BODY insertion mode.' );
+ }
+ } catch ( WP_HTML_Unsupported_Exception $e ) {
+ /*
+ * Exceptions are used in this class to escape deep call stacks that
+ * otherwise might involve messier calling and return conventions.
+ */
+ return false;
+ }
+ }
+
+ /**
+ * Computes the HTML breadcrumbs for the currently-matched node, if matched.
+ *
+ * Breadcrumbs start at the outer-most parent and descend toward the matched element.
+ *
+ * Example
+ *
+ * $p = WP_HTML_Processor::createFragment( '<p><strong><em><img></em></strong></p>' );
+ * $p->next_tag( 'IMG' );
+ * $p->get_breadcrumbs() === array( 'HTML', 'BODY', 'P', 'STRONG', 'EM', 'IMG' );
+ *
+ * @since 6.4.0
+ *
+ * @return string[]|null Array of tag-names representing path to matched node, if matched, otherwise null.
+ */
+ public function get_breadcrumbs() {
+ if ( ! $this->get_tag() ) {
+ return null;
+ }
+
+ $breadcrumbs = array();
+ foreach ( $this->state->stack_of_open_elements->walk_down() as $stack_item ) {
+ $breadcrumbs[] = $stack_item->node_name;
+ }
+
+ return $breadcrumbs;
+ }
+
+ /**
+ * Parses next element in the 'in body' insertion mode.
+ *
+ * This internal function performs the 'in body' insertion mode
+ * logic for the generalized `self::step()` function.
+ *
+ * @access private
+ *
+ * @since 6.4.0
+ *
+ * @throws WP_HTML_Unsupported_Exception
+ *
+ * @see https://html.spec.whatwg.org/#parsing-main-inbody
+ * @see self::step
+ *
+ * @return bool Whether an element was found.
+ */
+ private function step_in_body() {
+ $tag_name = $this->get_tag();
+ $op_sigil = $this->is_tag_closer() ? '-' : '+';
+ $op = "{$op_sigil}{$tag_name}";
+
+ switch ( $op ) {
+ /*
+ * > A start tag whose tag name is one of: "address", "article", "aside",
+ * > "blockquote", "center", "details", "dialog", "dir", "div", "dl",
+ * > "fieldset", "figcaption", "figure", "footer", "header", "hgroup",
+ * > "main", "menu", "nav", "ol", "p", "search", "section", "summary", "ul"
+ */
+ case '+BLOCKQUOTE':
+ case '+DIV':
+ case '+FIGCAPTION':
+ case '+FIGURE':
+ case '+P':
+ if ( $this->state->stack_of_open_elements->has_p_in_button_scope() ) {
+ $this->close_a_p_element();
+ }
+
+ $this->insert_html_element( $this->current_token );
+ return true;
+
+ /*
+ * > An end tag whose tag name is one of: "address", "article", "aside", "blockquote",
+ * > "button", "center", "details", "dialog", "dir", "div", "dl", "fieldset",
+ * > "figcaption", "figure", "footer", "header", "hgroup", "listing", "main",
+ * > "menu", "nav", "ol", "pre", "search", "section", "summary", "ul"
+ */
+ case '-BLOCKQUOTE':
+ case '-DIV':
+ case '-FIGCAPTION':
+ case '-FIGURE':
+ if ( ! $this->state->stack_of_open_elements->has_element_in_scope( $tag_name ) ) {
+ // Ignore the token.
+ return $this->step();
+ }
+
+ $this->generate_implied_end_tags();
+ $this->state->stack_of_open_elements->pop_until( $tag_name );
+ return true;
+
+ /*
+ * > An end tag whose tag name is "p"
+ */
+ case '-P':
+ if ( ! $this->state->stack_of_open_elements->has_p_in_button_scope() ) {
+ $this->insert_html_element( $this->current_token );
+ }
+
+ $this->close_a_p_element();
+ return true;
+
+ // > A start tag whose tag name is "a"
+ case '+A':
+ foreach ( $this->state->active_formatting_elements->walk_up() as $item ) {
+ switch ( $item->node_name ) {
+ case 'marker':
+ break;
+
+ case 'A':
+ $this->run_adoption_agency_algorithm();
+ $this->state->active_formatting_elements->remove_node( $item );
+ $this->state->stack_of_open_elements->remove_node( $item );
+ break;
+ }
+ }
+
+ $this->reconstruct_active_formatting_elements();
+ $this->insert_html_element( $this->current_token );
+ $this->state->active_formatting_elements->push( $this->current_token );
+ return true;
+
+ /*
+ * > A start tag whose tag name is one of: "b", "big", "code", "em", "font", "i",
+ * > "s", "small", "strike", "strong", "tt", "u"
+ */
+ case '+B':
+ case '+BIG':
+ case '+CODE':
+ case '+EM':
+ case '+FONT':
+ case '+I':
+ case '+S':
+ case '+SMALL':
+ case '+STRIKE':
+ case '+STRONG':
+ case '+TT':
+ case '+U':
+ $this->reconstruct_active_formatting_elements();
+ $this->insert_html_element( $this->current_token );
+ $this->state->active_formatting_elements->push( $this->current_token );
+ return true;
+
+ /*
+ * > An end tag whose tag name is one of: "a", "b", "big", "code", "em", "font", "i",
+ * > "nobr", "s", "small", "strike", "strong", "tt", "u"
+ */
+ case '-A':
+ case '-B':
+ case '-BIG':
+ case '-CODE':
+ case '-EM':
+ case '-FONT':
+ case '-I':
+ case '-S':
+ case '-SMALL':
+ case '-STRIKE':
+ case '-STRONG':
+ case '-TT':
+ case '-U':
+ $this->run_adoption_agency_algorithm();
+ return true;
+
+ /*
+ * > A start tag whose tag name is one of: "area", "br", "embed", "img", "keygen", "wbr"
+ */
+ case '+IMG':
+ $this->reconstruct_active_formatting_elements();
+ $this->insert_html_element( $this->current_token );
+ return true;
+
+ default:
+ $this->last_error = self::ERROR_UNSUPPORTED;
+ throw new WP_HTML_Unsupported_Exception( "Cannot process {$tag_name} element." );
+ }
+ }
+
+ /*
+ * Internal helpers
+ */
+
+ /**
+ * Creates a new bookmark for the currently-matched tag and returns generated name.
+ *
+ * @since 6.4.0
+ *
+ * @throws Exception
+ *
+ * @return string|false Name of created bookmark, or false if unable to create.
+ */
+ private function bookmark_tag() {
+ if ( ! $this->get_tag() ) {
+ return false;
+ }
+
+ if ( ! parent::set_bookmark( ++$this->bookmark_counter ) ) {
+ $this->last_error = self::ERROR_EXCEEDED_MAX_BOOKMARKS;
+ throw new Exception( 'could not allocate bookmark' );
+ }
+
+ return "{$this->bookmark_counter}";
+ }
+
+ /*
+ * HTML semantic overrides for Tag Processor
+ */
+
+ /**
+ * Returns the uppercase name of the matched tag.
+ *
+ * Example:
+ *
+ * $p = new WP_HTML_Tag_Processor( '<div class="test">Test</div>' );
+ * $p->next_tag() === true;
+ * $p->get_tag() === 'DIV';
+ *
+ * $p->next_tag() === false;
+ * $p->get_tag() === null;
+ *
+ * @since 6.4.0
+ *
+ * @return string|null Name of currently matched tag in input HTML, or `null` if none found.
+ */
+ public function get_tag() {
+ $tag_name = parent::get_tag();
+
+ switch ( $tag_name ) {
+ case 'IMAGE':
+ /*
+ * > A start tag whose tag name is "image"
+ * > Change the token's tag name to "img" and reprocess it. (Don't ask.)
+ */
+ return 'IMG';
+
+ default:
+ return $tag_name;
+ }
+ }
+
+ /**
+ * Removes a bookmark that is no longer needed.
+ *
+ * Releasing a bookmark frees up the small
+ * performance overhead it requires.
+ *
+ * @since 6.4.0
+ *
+ * @param string $bookmark_name Name of the bookmark to remove.
+ * @return bool Whether the bookmark already existed before removal.
+ */
+ public function release_bookmark( $bookmark_name ) {
+ return parent::release_bookmark( "_{$bookmark_name}" );
+ }
+
+ /**
+ * Moves the internal cursor in the Tag Processor to a given bookmark's location.
+ *
+ * In order to prevent accidental infinite loops, there's a
+ * maximum limit on the number of times seek() can be called.
+ *
+ * @since 6.4.0
+ *
+ * @param string $bookmark_name Jump to the place in the document identified by this bookmark name.
+ * @return bool Whether the internal cursor was successfully moved to the bookmark's location.
+ */
+ public function seek( $bookmark_name ) {
+ $actual_bookmark_name = "_{$bookmark_name}";
+ $processor_started_at = $this->current_token ? $this->bookmarks[ $this->current_token->bookmark_name ]->start : 0;
+ $bookmark_starts_at = $this->bookmarks[ $actual_bookmark_name ]->start;
+ $direction = $bookmark_starts_at > $processor_started_at ? 'forward' : 'backward';
+
+ switch ( $direction ) {
+ case 'forward':
+ // When moving forwards, re-parse the document until reaching the same location as the original bookmark.
+ while ( $this->step() ) {
+ if ( $bookmark_starts_at === $this->bookmarks[ $this->current_token->bookmark_name ]->start ) {
+ return true;
+ }
+ }
+
+ return false;
+
+ case 'backward':
+ /*
+ * When moving backwards, clear out all existing stack entries which appear after the destination
+ * bookmark. These could be stored for later retrieval, but doing so would require additional
+ * memory overhead and also demand that references and bookmarks are updated as the document
+ * changes. In time this could be a valuable optimization, but it's okay to give up that
+ * optimization in exchange for more CPU time to recompute the stack, to re-parse the
+ * document that may have already been parsed once.
+ */
+ foreach ( $this->state->stack_of_open_elements->walk_up() as $item ) {
+ if ( $bookmark_starts_at >= $this->bookmarks[ $item->bookmark_name ]->start ) {
+ break;
+ }
+
+ $this->state->stack_of_open_elements->remove_node( $item );
+ }
+
+ foreach ( $this->state->active_formatting_elements->walk_up() as $item ) {
+ if ( $bookmark_starts_at >= $this->bookmarks[ $item->bookmark_name ]->start ) {
+ break;
+ }
+
+ $this->state->active_formatting_elements->remove_node( $item );
+ }
+
+ return parent::seek( $actual_bookmark_name );
+ }
+ }
+
+ /**
+ * Sets a bookmark in the HTML document.
+ *
+ * Bookmarks represent specific places or tokens in the HTML
+ * document, such as a tag opener or closer. When applying
+ * edits to a document, such as setting an attribute, the
+ * text offsets of that token may shift; the bookmark is
+ * kept updated with those shifts and remains stable unless
+ * the entire span of text in which the token sits is removed.
+ *
+ * Release bookmarks when they are no longer needed.
+ *
+ * Example:
+ *
+ * <main><h2>Surprising fact you may not know!</h2></main>
+ * ^ ^
+ * \-|-- this `H2` opener bookmark tracks the token
+ *
+ * <main class="clickbait"><h2>Surprising fact you may no…
+ * ^ ^
+ * \-|-- it shifts with edits
+ *
+ * Bookmarks provide the ability to seek to a previously-scanned
+ * place in the HTML document. This avoids the need to re-scan
+ * the entire document.
+ *
+ * Example:
+ *
+ * <ul><li>One</li><li>Two</li><li>Three</li></ul>
+ * ^^^^
+ * want to note this last item
+ *
+ * $p = new WP_HTML_Tag_Processor( $html );
+ * $in_list = false;
+ * while ( $p->next_tag( array( 'tag_closers' => $in_list ? 'visit' : 'skip' ) ) ) {
+ * if ( 'UL' === $p->get_tag() ) {
+ * if ( $p->is_tag_closer() ) {
+ * $in_list = false;
+ * $p->set_bookmark( 'resume' );
+ * if ( $p->seek( 'last-li' ) ) {
+ * $p->add_class( 'last-li' );
+ * }
+ * $p->seek( 'resume' );
+ * $p->release_bookmark( 'last-li' );
+ * $p->release_bookmark( 'resume' );
+ * } else {
+ * $in_list = true;
+ * }
+ * }
+ *
+ * if ( 'LI' === $p->get_tag() ) {
+ * $p->set_bookmark( 'last-li' );
+ * }
+ * }
+ *
+ * Bookmarks intentionally hide the internal string offsets
+ * to which they refer. They are maintained internally as
+ * updates are applied to the HTML document and therefore
+ * retain their "position" - the location to which they
+ * originally pointed. The inability to use bookmarks with
+ * functions like `substr` is therefore intentional to guard
+ * against accidentally breaking the HTML.
+ *
+ * Because bookmarks allocate memory and require processing
+ * for every applied update, they are limited and require
+ * a name. They should not be created with programmatically-made
+ * names, such as "li_{$index}" with some loop. As a general
+ * rule they should only be created with string-literal names
+ * like "start-of-section" or "last-paragraph".
+ *
+ * Bookmarks are a powerful tool to enable complicated behavior.
+ * Consider double-checking that you need this tool if you are
+ * reaching for it, as inappropriate use could lead to broken
+ * HTML structure or unwanted processing overhead.
+ *
+ * @since 6.4.0
+ *
+ * @param string $bookmark_name Identifies this particular bookmark.
+ * @return bool Whether the bookmark was successfully created.
+ */
+ public function set_bookmark( $bookmark_name ) {
+ return parent::set_bookmark( "_{$bookmark_name}" );
+ }
+
+ /*
+ * HTML Parsing Algorithms
+ */
+
+ /**
+ * Closes a P element.
+ *
+ * @since 6.4.0
+ *
+ * @throws WP_HTML_Unsupported_Exception
+ *
+ * @see https://html.spec.whatwg.org/#close-a-p-element
+ */
+ private function close_a_p_element() {
+ $this->generate_implied_end_tags( 'P' );
+ $this->state->stack_of_open_elements->pop_until( 'P' );
+ }
+
+ /**
+ * Closes elements that have implied end tags.
+ *
+ * @since 6.4.0
+ *
+ * @throws Exception
+ *
+ * @see https://html.spec.whatwg.org/#generate-implied-end-tags
+ *
+ * @param string|null $except_for_this_element Perform as if this element doesn't exist in the stack of open elements.
+ */
+ private function generate_implied_end_tags( $except_for_this_element = null ) {
+ $elements_with_implied_end_tags = array(
+ 'P',
+ );
+
+ $current_node = $this->state->stack_of_open_elements->current_node();
+ while (
+ $current_node && $current_node->node_name !== $except_for_this_element &&
+ in_array( $this->state->stack_of_open_elements->current_node(), $elements_with_implied_end_tags, true )
+ ) {
+ $this->state->stack_of_open_elements->pop();
+ }
+ }
+
+ /**
+ * Reconstructs the active formatting elements.
+ *
+ * > This has the effect of reopening all the formatting elements that were opened
+ * > in the current body, cell, or caption (whichever is youngest) that haven't
+ * > been explicitly closed.
+ *
+ * @since 6.4.0
+ *
+ * @throws WP_HTML_Unsupported_Exception
+ *
+ * @see https://html.spec.whatwg.org/#reconstruct-the-active-formatting-elements
+ *
+ * @return bool Whether any formatting elements needed to be reconstructed.
+ */
+ private function reconstruct_active_formatting_elements() {
+ /*
+ * > If there are no entries in the list of active formatting elements, then there is nothing
+ * > to reconstruct; stop this algorithm.
+ */
+ if ( 0 === $this->state->active_formatting_elements->count() ) {
+ return false;
+ }
+
+ $last_entry = $this->state->active_formatting_elements->current_node();
+ if (
+ /*
+ * > If the last (most recently added) entry in the list of active formatting elements is a marker;
+ * > stop this algorithm.
+ */
+ 'marker' === $last_entry->node_name ||
+
+ /*
+ * > If the last (most recently added) entry in the list of active formatting elements is an
+ * > element that is in the stack of open elements, then there is nothing to reconstruct;
+ * > stop this algorithm.
+ */
+ $this->state->stack_of_open_elements->contains_node( $last_entry )
+ ) {
+ return false;
+ }
+
+ $this->last_error = self::ERROR_UNSUPPORTED;
+ throw new WP_HTML_Unsupported_Exception( 'Cannot reconstruct active formatting elements when advancing and rewinding is required.' );
+ }
+
+ /**
+ * Runs the adoption agency algorithm.
+ *
+ * @since 6.4.0
+ *
+ * @throws WP_HTML_Unsupported_Exception
+ *
+ * @see https://html.spec.whatwg.org/#adoption-agency-algorithm
+ */
+ private function run_adoption_agency_algorithm() {
+ $budget = 1000;
+ $subject = $this->get_tag();
+ $current_node = $this->state->stack_of_open_elements->current_node();
+
+ if (
+ // > If the current node is an HTML element whose tag name is subject
+ $current_node && $subject === $current_node->node_name &&
+ // > the current node is not in the list of active formatting elements
+ ! $this->state->active_formatting_elements->contains_node( $current_node )
+ ) {
+ $this->state->stack_of_open_elements->pop();
+ return;
+ }
+
+ $outer_loop_counter = 0;
+ while ( $budget-- > 0 ) {
+ if ( $outer_loop_counter++ >= 8 ) {
+ return;
+ }
+
+ /*
+ * > Let formatting element be the last element in the list of active formatting elements that:
+ * > - is between the end of the list and the last marker in the list,
+ * > if any, or the start of the list otherwise,
+ * > - and has the tag name subject.
+ */
+ $formatting_element = null;
+ foreach ( $this->state->active_formatting_elements->walk_up() as $item ) {
+ if ( 'marker' === $item->node_name ) {
+ break;
+ }
+
+ if ( $subject === $item->node_name ) {
+ $formatting_element = $item;
+ break;
+ }
+ }
+
+ // > If there is no such element, then return and instead act as described in the "any other end tag" entry above.
+ if ( null === $formatting_element ) {
+ $this->last_error = self::ERROR_UNSUPPORTED;
+ throw new WP_HTML_Unsupported_Exception( 'Cannot run adoption agency when "any other end tag" is required.' );
+ }
+
+ // > If formatting element is not in the stack of open elements, then this is a parse error; remove the element from the list, and return.
+ if ( ! $this->state->stack_of_open_elements->contains_node( $formatting_element ) ) {
+ $this->state->active_formatting_elements->remove_node( $formatting_element->bookmark_name );
+ return;
+ }
+
+ // > If formatting element is in the stack of open elements, but the element is not in scope, then this is a parse error; return.
+ if ( ! $this->state->stack_of_open_elements->has_element_in_scope( $formatting_element->node_name ) ) {
+ return;
+ }
+
+ /*
+ * > Let furthest block be the topmost node in the stack of open elements that is lower in the stack
+ * > than formatting element, and is an element in the special category. There might not be one.
+ */
+ $is_above_formatting_element = true;
+ $furthest_block = null;
+ foreach ( $this->state->stack_of_open_elements->walk_down() as $item ) {
+ if ( $is_above_formatting_element && $formatting_element->bookmark_name !== $item->bookmark_name ) {
+ continue;
+ }
+
+ if ( $is_above_formatting_element ) {
+ $is_above_formatting_element = false;
+ continue;
+ }
+
+ if ( self::is_special( $item->node_name ) ) {
+ $furthest_block = $item;
+ break;
+ }
+ }
+
+ /*
+ * > If there is no furthest block, then the UA must first pop all the nodes from the bottom of the
+ * > stack of open elements, from the current node up to and including formatting element, then
+ * > remove formatting element from the list of active formatting elements, and finally return.
+ */
+ if ( null === $furthest_block ) {
+ foreach ( $this->state->stack_of_open_elements->walk_up() as $item ) {
+ $this->state->stack_of_open_elements->pop();
+
+ if ( $formatting_element->bookmark_name === $item->bookmark_name ) {
+ $this->state->active_formatting_elements->remove_node( $formatting_element );
+ return;
+ }
+ }
+ }
+
+ $this->last_error = self::ERROR_UNSUPPORTED;
+ throw new WP_HTML_Unsupported_Exception( 'Cannot extract common ancestor in adoption agency algorithm.' );
+ }
+
+ $this->last_error = self::ERROR_UNSUPPORTED;
+ throw new WP_HTML_Unsupported_Exception( 'Cannot run adoption agency when looping required.' );
+ }
+
+ /**
+ * Inserts an HTML element on the stack of open elements.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#insert-a-foreign-element
+ *
+ * @param WP_HTML_Token $token Name of bookmark pointing to element in original input HTML.
+ */
+ private function insert_html_element( $token ) {
+ $this->state->stack_of_open_elements->push( $token );
+ }
+
+ /*
+ * HTML Specification Helpers
+ */
+
+ /**
+ * Returns whether an element of a given name is in the HTML special category.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#special
+ *
+ * @param string $tag_name Name of element to check.
+ * @return bool Whether the element of the given name is in the special category.
+ */
+ public static function is_special( $tag_name ) {
+ $tag_name = strtoupper( $tag_name );
+
+ return (
+ 'ADDRESS' === $tag_name ||
+ 'APPLET' === $tag_name ||
+ 'AREA' === $tag_name ||
+ 'ARTICLE' === $tag_name ||
+ 'ASIDE' === $tag_name ||
+ 'BASE' === $tag_name ||
+ 'BASEFONT' === $tag_name ||
+ 'BGSOUND' === $tag_name ||
+ 'BLOCKQUOTE' === $tag_name ||
+ 'BODY' === $tag_name ||
+ 'BR' === $tag_name ||
+ 'BUTTON' === $tag_name ||
+ 'CAPTION' === $tag_name ||
+ 'CENTER' === $tag_name ||
+ 'COL' === $tag_name ||
+ 'COLGROUP' === $tag_name ||
+ 'DD' === $tag_name ||
+ 'DETAILS' === $tag_name ||
+ 'DIR' === $tag_name ||
+ 'DIV' === $tag_name ||
+ 'DL' === $tag_name ||
+ 'DT' === $tag_name ||
+ 'EMBED' === $tag_name ||
+ 'FIELDSET' === $tag_name ||
+ 'FIGCAPTION' === $tag_name ||
+ 'FIGURE' === $tag_name ||
+ 'FOOTER' === $tag_name ||
+ 'FORM' === $tag_name ||
+ 'FRAME' === $tag_name ||
+ 'FRAMESET' === $tag_name ||
+ 'H1' === $tag_name ||
+ 'H2' === $tag_name ||
+ 'H3' === $tag_name ||
+ 'H4' === $tag_name ||
+ 'H5' === $tag_name ||
+ 'H6' === $tag_name ||
+ 'HEAD' === $tag_name ||
+ 'HEADER' === $tag_name ||
+ 'HGROUP' === $tag_name ||
+ 'HR' === $tag_name ||
+ 'HTML' === $tag_name ||
+ 'IFRAME' === $tag_name ||
+ 'IMG' === $tag_name ||
+ 'INPUT' === $tag_name ||
+ 'KEYGEN' === $tag_name ||
+ 'LI' === $tag_name ||
+ 'LINK' === $tag_name ||
+ 'LISTING' === $tag_name ||
+ 'MAIN' === $tag_name ||
+ 'MARQUEE' === $tag_name ||
+ 'MENU' === $tag_name ||
+ 'META' === $tag_name ||
+ 'NAV' === $tag_name ||
+ 'NOEMBED' === $tag_name ||
+ 'NOFRAMES' === $tag_name ||
+ 'NOSCRIPT' === $tag_name ||
+ 'OBJECT' === $tag_name ||
+ 'OL' === $tag_name ||
+ 'P' === $tag_name ||
+ 'PARAM' === $tag_name ||
+ 'PLAINTEXT' === $tag_name ||
+ 'PRE' === $tag_name ||
+ 'SCRIPT' === $tag_name ||
+ 'SEARCH' === $tag_name ||
+ 'SECTION' === $tag_name ||
+ 'SELECT' === $tag_name ||
+ 'SOURCE' === $tag_name ||
+ 'STYLE' === $tag_name ||
+ 'SUMMARY' === $tag_name ||
+ 'TABLE' === $tag_name ||
+ 'TBODY' === $tag_name ||
+ 'TD' === $tag_name ||
+ 'TEMPLATE' === $tag_name ||
+ 'TEXTAREA' === $tag_name ||
+ 'TFOOT' === $tag_name ||
+ 'TH' === $tag_name ||
+ 'THEAD' === $tag_name ||
+ 'TITLE' === $tag_name ||
+ 'TR' === $tag_name ||
+ 'TRACK' === $tag_name ||
+ 'UL' === $tag_name ||
+ 'WBR' === $tag_name ||
+ 'XMP' === $tag_name ||
+
+ // MathML
+ 'MI' === $tag_name ||
+ 'MO' === $tag_name ||
+ 'MN' === $tag_name ||
+ 'MS' === $tag_name ||
+ 'MTEXT' === $tag_name ||
+ 'ANNOTATION-XML' === $tag_name ||
+
+ // SVG
+ 'FOREIGNOBJECT' === $tag_name ||
+ 'DESC' === $tag_name ||
+ 'TITLE' === $tag_name
+ );
+ }
+
+ /**
+ * Returns whether a given element is an HTML Void Element
+ *
+ * > area, base, br, col, embed, hr, img, input, link, meta, source, track, wbr
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#void-elements
+ *
+ * @param string $tag_name Name of HTML tag to check.
+ * @return bool Whether the given tag is an HTML Void Element.
+ */
+ public static function is_void( $tag_name ) {
+ $tag_name = strtoupper( $tag_name );
+
+ return (
+ 'AREA' === $tag_name ||
+ 'BASE' === $tag_name ||
+ 'BR' === $tag_name ||
+ 'COL' === $tag_name ||
+ 'EMBED' === $tag_name ||
+ 'HR' === $tag_name ||
+ 'IMG' === $tag_name ||
+ 'INPUT' === $tag_name ||
+ 'LINK' === $tag_name ||
+ 'META' === $tag_name ||
+ 'SOURCE' === $tag_name ||
+ 'TRACK' === $tag_name ||
+ 'WBR' === $tag_name
+ );
+ }
+
+ /*
+ * Constants that would pollute the top of the class if they were found there.
+ */
+
+ /**
+ * Indicates that the next HTML token should be parsed and processed.
+ *
+ * @since 6.4.0
+ *
+ * @var string
+ */
+ const PROCESS_NEXT_NODE = 'process-next-node';
+
+ /**
+ * Indicates that the current HTML token should be reprocessed in the newly-selected insertion mode.
+ *
+ * @since 6.4.0
+ *
+ * @var string
+ */
+ const REPROCESS_CURRENT_NODE = 'reprocess-current-node';
+
+ /**
+ * Indicates that the parser encountered unsupported markup and has bailed.
+ *
+ * @since 6.4.0
+ *
+ * @var string
+ */
+ const ERROR_UNSUPPORTED = 'unsupported';
+
+ /**
+ * Indicates that the parser encountered more HTML tokens than it
+ * was able to process and has bailed.
+ *
+ * @since 6.4.0
+ *
+ * @var string
+ */
+ const ERROR_EXCEEDED_MAX_BOOKMARKS = 'exceeded-max-bookmarks';
+
+ /**
+ * Unlock code that must be passed into the constructor to create this class.
+ *
+ * This class extends {@see WP_HTML_Tag_Processor}, which has a public class
+ * constructor. Therefore, it's not possible to have a private constructor here.
+ *
+ * This unlock code is used to ensure that anyone calling the constructor is
+ * doing so with a full understanding that it's intended to be a private API.
+ */
+ const CONSTRUCTOR_UNLOCK_CODE = 'Use WP_HTML_Processor::createFragment instead of calling the class constructor directly.';
+}
</ins></span></pre></div>
<a id="trunksrcwpincludeshtmlapiclasswphtmltagprocessorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php 2023-07-20 00:04:33 UTC (rev 56273)
+++ trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php 2023-07-20 13:41:21 UTC (rev 56274)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -522,7 +522,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string|null $class_name Tag must contain this whole class name to match.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string|null $tag_closers "visit" or "skip": whether to stop on tag closers, e.g. </div>.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return boolean Whether a tag was matched.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Whether a tag was matched.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function next_tag( $query = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->parse_query( $query );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -673,7 +673,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! array_key_exists( $name, $this->bookmarks ) && count( $this->bookmarks ) >= self::MAX_BOOKMARKS ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! array_key_exists( $name, $this->bookmarks ) && count( $this->bookmarks ) >= static::MAX_BOOKMARKS ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> _doing_it_wrong(
</span><span class="cx" style="display: block; padding: 0 10px"> __METHOD__,
</span><span class="cx" style="display: block; padding: 0 10px"> __( 'Too many bookmarks: cannot create any more.' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1538,7 +1538,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ++$this->seek_count > self::MAX_SEEK_OPS ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ++$this->seek_count > static::MAX_SEEK_OPS ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> _doing_it_wrong(
</span><span class="cx" style="display: block; padding: 0 10px"> __METHOD__,
</span><span class="cx" style="display: block; padding: 0 10px"> __( 'Too many calls to seek() - this can lead to performance issues.' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2221,7 +2221,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return boolean Whether the given tag and its attribute match the search criteria.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Whether the given tag and its attribute match the search criteria.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> private function matches() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->is_closing_tag && ! $this->stop_on_tag_closers ) {
</span></span></pre></div>
<a id="trunksrcwpincludeshtmlapiclasswphtmltokenphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/html-api/class-wp-html-token.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/html-api/class-wp-html-token.php (rev 0)
+++ trunk/src/wp-includes/html-api/class-wp-html-token.php 2023-07-20 13:41:21 UTC (rev 56274)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,95 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * HTML API: WP_HTML_Token class
+ *
+ * @package WordPress
+ * @subpackage HTML-API
+ * @since 6.4.0
+ */
+
+/**
+ * Core class used by the HTML processor during HTML parsing
+ * for referring to tokens in the input HTML string.
+ *
+ * This class is designed for internal use by the HTML processor.
+ *
+ * @since 6.4.0
+ *
+ * @access private
+ *
+ * @see WP_HTML_Processor
+ */
+class WP_HTML_Token {
+ /**
+ * Name of bookmark corresponding to source of token in input HTML string.
+ *
+ * Having a bookmark name does not imply that the token still exists. It
+ * may be that the source token and underlying bookmark was wiped out by
+ * some modification to the source HTML.
+ *
+ * @since 6.4.0
+ *
+ * @var string
+ */
+ public $bookmark_name = null;
+
+ /**
+ * Name of node; lowercase names such as "marker" are not HTML elements.
+ *
+ * For HTML elements/tags this value should come from {@see WP_HTML_Processor::get_tag}.
+ *
+ * @since 6.4.0
+ *
+ * @var string
+ */
+ public $node_name = null;
+
+ /**
+ * Whether node contains the self-closing flag.
+ *
+ * A node may have a self-closing flag when it shouldn't. This value
+ * only reports if the flag is present in the original HTML.
+ *
+ * @since 6.4.0
+ *
+ * @see https://html.spec.whatwg.org/#self-closing-flag
+ *
+ * @var bool
+ */
+ public $has_self_closing_flag = false;
+
+ /**
+ * Called when token is garbage-collected or otherwise destroyed.
+ *
+ * @var callable|null
+ */
+ public $on_destroy = null;
+
+ /**
+ * Constructor - creates a reference to a token in some external HTML string.
+ *
+ * @since 6.4.0
+ *
+ * @param string $bookmark_name Name of bookmark corresponding to location in HTML where token is found.
+ * @param string $node_name Name of node token represents; if uppercase, an HTML element; if lowercase, a special value like "marker".
+ * @param bool $has_self_closing_flag Whether the source token contains the self-closing flag, regardless of whether it's valid.
+ * @param callable $on_destroy Function to call when destroying token, useful for releasing the bookmark.
+ */
+ public function __construct( $bookmark_name, $node_name, $has_self_closing_flag, $on_destroy = null ) {
+ $this->bookmark_name = $bookmark_name;
+ $this->node_name = $node_name;
+ $this->has_self_closing_flag = $has_self_closing_flag;
+ $this->on_destroy = $on_destroy;
+ }
+
+ /**
+ * Destructor.
+ *
+ * @since 6.4.0
+ */
+ public function __destruct() {
+ if ( is_callable( $this->on_destroy ) ) {
+ call_user_func( $this->on_destroy, $this->bookmark_name );
+ }
+ }
+}
</ins></span></pre></div>
<a id="trunksrcwpincludeshtmlapiclasswphtmlunsupportedexceptionphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/html-api/class-wp-html-unsupported-exception.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/html-api/class-wp-html-unsupported-exception.php (rev 0)
+++ trunk/src/wp-includes/html-api/class-wp-html-unsupported-exception.php 2023-07-20 13:41:21 UTC (rev 56274)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,31 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * HTML API: WP_HTML_Unsupported_Exception class
+ *
+ * @package WordPress
+ * @subpackage HTML-API
+ * @since 6.4.0
+ */
+
+/**
+ * Core class used by the HTML processor during HTML parsing
+ * for indicating that a given operation is unsupported.
+ *
+ * This class is designed for internal use by the HTML processor.
+ *
+ * The HTML API aims to operate in compliance with the HTML5
+ * specification, but does not implement the full specification.
+ * In cases where it lacks support it should not cause breakage
+ * or unexpected behavior. In the cases where it recognizes that
+ * it cannot proceed, this class is used to abort from any
+ * operation and signify that the given HTML cannot be processed.
+ *
+ * @since 6.4.0
+ *
+ * @access private
+ *
+ * @see WP_HTML_Processor
+ */
+class WP_HTML_Unsupported_Exception extends Exception {
+
+}
</ins></span></pre></div>
<a id="trunksrcwpsettingsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-settings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-settings.php 2023-07-20 00:04:33 UTC (rev 56273)
+++ trunk/src/wp-settings.php 2023-07-20 13:41:21 UTC (rev 56274)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -239,6 +239,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/html-api/class-wp-html-span.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/html-api/class-wp-html-text-replacement.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/html-api/class-wp-html-tag-processor.php';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+require ABSPATH . WPINC . '/html-api/class-wp-html-unsupported-exception.php';
+require ABSPATH . WPINC . '/html-api/class-wp-html-active-formatting-elements.php';
+require ABSPATH . WPINC . '/html-api/class-wp-html-open-elements.php';
+require ABSPATH . WPINC . '/html-api/class-wp-html-token.php';
+require ABSPATH . WPINC . '/html-api/class-wp-html-processor-state.php';
+require ABSPATH . WPINC . '/html-api/class-wp-html-processor.php';
</ins><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/class-wp-http.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/class-wp-http-streams.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/class-wp-http-curl.php';
</span></span></pre></div>
<a id="trunktestsphpunittestshtmlapiwpHtmlProcessorphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/html-api/wpHtmlProcessor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/html-api/wpHtmlProcessor.php (rev 0)
+++ trunk/tests/phpunit/tests/html-api/wpHtmlProcessor.php 2023-07-20 13:41:21 UTC (rev 56274)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,118 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Unit tests covering WP_HTML_Processor functionality.
+ *
+ * @package WordPress
+ * @subpackage HTML-API
+ *
+ * @since 6.4.0
+ *
+ * @group html-api
+ *
+ * @coversDefaultClass WP_HTML_Processor
+ */
+class Tests_HtmlApi_wpHtmlProcessor extends WP_UnitTestCase {
+ /**
+ * Ensure that the HTML Processor's public constructor function warns a developer to call
+ * the static creator methods instead of directly instantiating a new class.
+ *
+ * The Tag Processor's constructor method is public and PHP doesn't allow changing the
+ * visibility for a method on a subclass, which means that the HTML Processor must
+ * maintain the public interface. However, constructors cannot fail to construct, so
+ * if there are pre-conditions (such as the context node, the encoding form, and the
+ * parsing mode with the HTML Processor) these must be handled through static factory
+ * methods on the class.
+ *
+ * The HTML Processor requires a sentinel string as an optional parameter that hints
+ * at using the static methods. In the absence of the optional parameter it instructs
+ * the callee that it should be using those static methods instead.
+ *
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Processor::__construct
+ */
+ public function test_warns_that_the_static_creator_methods_should_be_called_instead_of_the_public_constructor() {
+ $this->setExpectedIncorrectUsage( 'WP_HTML_Processor::__construct' );
+
+ new WP_HTML_Processor( '<p>Light roast.</p>' );
+
+ $this->assertNotNull(
+ $this->caught_doing_it_wrong['WP_HTML_Processor::__construct'],
+ "Calling the public constructor should warn to call the static creator methods instead, but didn't."
+ );
+ }
+
+ /**
+ * Ensures that the HTML Processor maintains its internal state through seek calls.
+ *
+ * Because the HTML Processor must track a stack of open elements and active formatting
+ * elements, when it seeks to another location within its document it must adjust those
+ * stacks, its internal state, in such a way that they remain valid after the seek.
+ *
+ * For instance, if currently matched inside an LI element and the Processor seeks to
+ * an earlier location before the parent UL, then it should not report that it's still
+ * inside an open LI element.
+ *
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Processor::next_tag
+ * @covers WP_HTML_Processor::seek
+ *
+ * @throws WP_HTML_Unsupported_Exception
+ */
+ public function test_clear_to_navigate_after_seeking() {
+ $p = WP_HTML_Processor::createFragment( '<div one><strong></strong></div><p><strong two></strong></p>' );
+
+ while ( $p->next_tag() ) {
+ // Create a bookmark before entering a stack of elements and formatting elements.
+ if ( null !== $p->get_attribute( 'one' ) ) {
+ $this->assertTrue( $p->set_bookmark( 'one' ) );
+ continue;
+ }
+
+ // Create a bookmark inside of that stack.
+ if ( null !== $p->get_attribute( 'two' ) ) {
+ $p->set_bookmark( 'two' );
+ break;
+ }
+ }
+
+ // Ensure that it's possible to seek back to the outside location.
+ $this->assertTrue( $p->seek( 'one' ), 'Could not seek to earlier-seen location.' );
+ $this->assertSame( 'DIV', $p->get_tag(), "Should have jumped back to DIV but found {$p->get_tag()} instead." );
+
+ /*
+ * Ensure that the P element from the inner location isn't still on the stack of open elements.
+ * If it were, then the first STRONG element, inside the outer DIV would match the next call.
+ */
+ $this->assertTrue( $p->next_tag( array( 'breadcrumbs' => array( 'P', 'STRONG' ) ) ), 'Failed to find given location after seeking.' );
+
+ // Only if the stack is properly managed will the processor advance to the inner STRONG element.
+ $this->assertTrue( $p->get_attribute( 'two' ), "Found the wrong location given the breadcrumbs, at {$p->get_tag()}." );
+
+ // Ensure that in seeking backwards the processor reports the correct full set of breadcrumbs.
+ $this->assertTrue( $p->seek( 'one' ), 'Failed to jump back to first bookmark.' );
+ $this->assertSame( array( 'HTML', 'BODY', 'DIV' ), $p->get_breadcrumbs(), 'Found wrong set of breadcrumbs navigating to node "one".' );
+
+ // Ensure that in seeking forwards the processor reports the correct full set of breadcrumbs.
+ $this->assertTrue( $p->seek( 'two' ), 'Failed to jump forward to second bookmark.' );
+ $this->assertTrue( $p->get_attribute( 'two' ), "Found the wrong location given the bookmark, at {$p->get_tag()}." );
+
+ $this->assertSame( array( 'HTML', 'BODY', 'P', 'STRONG' ), $p->get_breadcrumbs(), 'Found wrong set of bookmarks navigating to node "two".' );
+ }
+
+ /**
+ * Ensures that support is added for reconstructing active formatting elements
+ * before the HTML Processor handles situations with unclosed formats requiring it.
+ *
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Processor::reconstruct_active_formatting_elements
+ */
+ public function test_fails_to_reconstruct_formatting_elements() {
+ $p = WP_HTML_Processor::createFragment( '<p><em>One<p><em>Two<p><em>Three<p><em>Four' );
+
+ $this->assertTrue( $p->next_tag( 'EM' ), 'Could not find first EM.' );
+ $this->assertFalse( $p->next_tag( 'EM' ), 'Should have aborted before finding second EM as it required reconstructing the first EM.' );
+ }
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestshtmlapiwpHtmlProcessorBreadcrumbsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/html-api/wpHtmlProcessorBreadcrumbs.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/html-api/wpHtmlProcessorBreadcrumbs.php (rev 0)
+++ trunk/tests/phpunit/tests/html-api/wpHtmlProcessorBreadcrumbs.php 2023-07-20 13:41:21 UTC (rev 56274)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,427 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Unit tests covering WP_HTML_Processor functionality.
+ *
+ * @package WordPress
+ * @subpackage HTML-API
+ *
+ * @since 6.4.0
+ *
+ * @group html-api
+ *
+ * @coversDefaultClass WP_HTML_Processor
+ */
+class Tests_HtmlApi_wpHtmlProcessorBreadcrumbs extends WP_UnitTestCase {
+ /**
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Processor::step
+ *
+ * @dataProvider data_single_tag_of_supported_elements
+ *
+ * @param string $html HTML with at least one tag to scan.
+ * @param string $tag_name Name of first tag in HTML (because HTML treats IMAGE as IMG this may not match the HTML).
+ */
+ public function test_navigates_into_normative_html_for_supported_elements( $html, $tag_name ) {
+ $p = WP_HTML_Processor::createFragment( $html );
+
+ $this->assertTrue( $p->step(), "Failed to step into supported {$tag_name} element." );
+ $this->assertSame( $tag_name, $p->get_tag(), "Misread {$tag_name} as a {$p->get_tag()} element." );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_single_tag_of_supported_elements() {
+ $supported_elements = array(
+ 'A',
+ 'B',
+ 'BIG',
+ 'CODE',
+ 'DIV',
+ 'EM',
+ 'FIGCAPTION',
+ 'FIGURE',
+ 'FONT',
+ 'I',
+ 'IMG',
+ 'P',
+ 'SMALL',
+ 'STRIKE',
+ 'STRONG',
+ 'TT',
+ 'U',
+ );
+
+ $data = array();
+ foreach ( $supported_elements as $tag_name ) {
+ $data[ $tag_name ] = array( "<{$tag_name}>", $tag_name );
+ }
+
+ $data['IMAGE (treated as an IMG)'] = array( '<image>', 'IMG' );
+
+ return $data;
+ }
+
+ /**
+ * Ensures that no new HTML elements are accidentally partially-supported.
+ *
+ * When introducing support for new HTML elements, there are multiple places
+ * in the HTML Processor that need to be updated, until the time that the class
+ * has full HTML5 support. Because of this, these tests lock down the interface
+ * to ensure that support isn't accidentally updated in one place for a new
+ * element while overlooked in another.
+ *
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Processor::step
+ *
+ * @dataProvider data_unsupported_elements
+ *
+ * @param string $html HTML string containing unsupported elements.
+ */
+ public function test_fails_when_encountering_unsupported_tag( $html ) {
+ $p = WP_HTML_Processor::createFragment( $html );
+
+ $this->assertFalse( $p->step(), "Should not have stepped into unsupported {$p->get_tag()} element." );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_unsupported_elements() {
+ $unsupported_elements = array(
+ 'ABBR',
+ 'ACRONYM', // Neutralized
+ 'ADDRESS',
+ 'APPLET', // Deprecated
+ 'AREA',
+ 'ARTICLE',
+ 'ASIDE',
+ 'AUDIO',
+ 'BASE',
+ 'BDI',
+ 'BDO',
+ 'BGSOUND', // Deprecated; self-closing if self-closing flag provided, otherwise normal.
+ 'BLINK', // Deprecated
+ 'BODY',
+ 'BR',
+ 'BUTTON',
+ 'CANVAS',
+ 'CAPTION',
+ 'CENTER', // Neutralized
+ 'CITE',
+ 'COL',
+ 'COLGROUP',
+ 'DATA',
+ 'DATALIST',
+ 'DD',
+ 'DEL',
+ 'DETAILS',
+ 'DEFN',
+ 'DIALOG',
+ 'DL',
+ 'DT',
+ 'EMBED',
+ 'FIELDSET',
+ 'FOOTER',
+ 'FORM',
+ 'FRAME',
+ 'FRAMESET',
+ 'H1',
+ 'H2',
+ 'H3',
+ 'H4',
+ 'H5',
+ 'H6',
+ 'HEAD',
+ 'HEADER',
+ 'HGROUP',
+ 'HR',
+ 'HTML',
+ 'IFRAME',
+ 'INPUT',
+ 'INS',
+ 'ISINDEX', // Deprecated
+ 'KBD',
+ 'KEYGEN', // Deprecated; void
+ 'LABEL',
+ 'LEGEND',
+ 'LI',
+ 'LINK',
+ 'LISTING', // Deprecated, use PRE instead.
+ 'MAIN',
+ 'MAP',
+ 'MARK',
+ 'MARQUEE', // Deprecated
+ 'MATH',
+ 'MENU',
+ 'META',
+ 'METER',
+ 'MULTICOL', // Deprecated
+ 'NAV',
+ 'NEXTID', // Deprecated
+ 'NOBR', // Neutralized
+ 'NOEMBED', // Neutralized
+ 'NOFRAMES', // Neutralized
+ 'NOSCRIPT',
+ 'OBJECT',
+ 'OL',
+ 'OPTGROUP',
+ 'OPTION',
+ 'OUTPUT',
+ 'PICTURE',
+ 'PLAINTEXT', // Neutralized
+ 'PRE',
+ 'PROGRESS',
+ 'Q',
+ 'RB', // Neutralized
+ 'RP',
+ 'RT',
+ 'RTC', // Neutralized
+ 'RUBY',
+ 'SAMP',
+ 'SCRIPT',
+ 'SECTION',
+ 'SELECT',
+ 'SLOT',
+ 'SOURCE',
+ 'SPACER', // Deprecated
+ 'SPAN',
+ 'STYLE',
+ 'SUB',
+ 'SUMMARY',
+ 'SUP',
+ 'SVG',
+ 'TABLE',
+ 'TBODY',
+ 'TD',
+ 'TEMPLATE',
+ 'TEXTAREA',
+ 'TFOOT',
+ 'TH',
+ 'THEAD',
+ 'TIME',
+ 'TITLE',
+ 'TR',
+ 'TRACK',
+ 'UL',
+ 'VAR',
+ 'VIDEO',
+ 'WBR',
+ 'XMP', // Deprecated, use PRE instead.
+
+ // Made up elements, custom elements.
+ 'X-NOT-AN-HTML-ELEMENT',
+ 'HUMAN-TIME',
+ );
+
+ $data = array();
+ foreach ( $unsupported_elements as $tag_name ) {
+ $data[ $tag_name ] = array( "<{$tag_name}>" );
+ }
+
+ return $data;
+ }
+
+ /**
+ * @ticket 58517
+ *
+ * @dataProvider data_unsupported_markup
+ *
+ * @param string $html HTML containing unsupported markup.
+ */
+ public function test_fails_when_encountering_unsupported_markup( $html, $description ) {
+ $p = WP_HTML_Processor::createFragment( $html );
+
+ while ( $p->step() && null === $p->get_attribute( 'supported' ) ) {
+ continue;
+ }
+
+ $this->assertTrue( $p->get_attribute( 'supported' ), 'Did not find required supported element.' );
+ $this->assertFalse( $p->step(), "Didn't properly reject unsupported markup: {$description}" );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_unsupported_markup() {
+ return array(
+ 'A with formatting following unclosed A' => array(
+ '<a><strong>Click <a supported><big unsupported>Here</big></a></strong></a>',
+ 'Unclosed formatting requires complicated reconstruction.',
+ ),
+
+ 'A after unclosed A inside DIV' => array(
+ '<a><div supported><a unsupported></div></a>',
+ 'A is a formatting element, which requires more complicated reconstruction.',
+ ),
+ );
+ }
+
+ /**
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Processor::next_tag
+ *
+ * @dataProvider data_html_target_with_breadcrumbs
+ *
+ * @param string $html HTML string with tags in it, one of which contains the "target" attribute.
+ * @param array $breadcrumbs Breadcrumbs of element with "target" attribute set.
+ * @param int $n How many breadcrumb matches to scan through in order to find "target" element.
+ */
+ public function test_finds_correct_tag_given_breadcrumbs( $html, $breadcrumbs, $n ) {
+ $p = WP_HTML_Processor::createFragment( $html );
+
+ $p->next_tag(
+ array(
+ 'breadcrumbs' => $breadcrumbs,
+ 'match_offset' => $n,
+ )
+ );
+
+ $this->assertNotNull( $p->get_tag(), 'Failed to find target node.' );
+ $this->assertTrue( $p->get_attribute( 'target' ), "Found {$p->get_tag()} element didn't contain the necessary 'target' attribute." );
+ }
+
+ /**
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Processor::get_breadcrumbs
+ *
+ * @dataProvider data_html_target_with_breadcrumbs
+ *
+ * @param string $html HTML string with tags in it, one of which contains the "target" attribute.
+ * @param array $breadcrumbs Breadcrumbs of element with "target" attribute set.
+ * @param int $ignored_n Not used in this test but provided in the dataset for other tests.
+ * @return void
+ */
+ public function test_reports_correct_breadcrumbs_for_html( $html, $breadcrumbs, $ignored_n ) {
+ $p = WP_HTML_Processor::createFragment( $html );
+
+ while ( $p->next_tag() && null === $p->get_attribute( 'target' ) ) {
+ continue;
+ }
+
+ $this->assertNotNull( $p->get_tag(), 'Failed to find the target node.' );
+ $this->assertSame( $breadcrumbs, $p->get_breadcrumbs(), 'Found the wrong path from the root of the HTML document to the target node.' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_html_target_with_breadcrumbs() {
+ return array(
+ 'Simple IMG tag' => array( '<img target>', array( 'HTML', 'BODY', 'IMG' ), 1 ),
+ 'Two sibling IMG tags' => array( '<img><img target>', array( 'HTML', 'BODY', 'IMG' ), 2 ),
+ 'Three sibling IMG tags, an IMAGE in last place' => array( '<img><img><image target>', array( 'HTML', 'BODY', 'IMG' ), 3 ),
+ 'IMG inside a DIV' => array( '<div><img target></div>', array( 'HTML', 'BODY', 'DIV', 'IMG' ), 1 ),
+ 'DIV inside a DIV' => array( '<div><div target></div>', array( 'HTML', 'BODY', 'DIV', 'DIV' ), 1 ),
+ 'IMG inside many DIVS' => array( '<div><div><div><div><img target></div></div></div></div>', array( 'HTML', 'BODY', 'DIV', 'DIV', 'DIV', 'DIV', 'IMG' ), 1 ),
+ 'DIV inside DIV after IMG' => array( '<div><img><div target></div></div>', array( 'HTML', 'BODY', 'DIV', 'DIV' ), 1 ),
+ 'IMG after DIV' => array( '<div></div><img target>', array( 'HTML', 'BODY', 'IMG' ), 1 ),
+ 'IMG after two DIVs' => array( '<div></div><div></div><img target>', array( 'HTML', 'BODY', 'IMG' ), 1 ),
+ 'IMG after two DIVs with nesting' => array( '<div><div><img></div></div><div></div><img target>', array( 'HTML', 'BODY', 'IMG' ), 1 ),
+ 'IMG after invalid DIV closer' => array( '</div><img target>', array( 'HTML', 'BODY', 'IMG' ), 1 ),
+ 'EM inside DIV' => array( '<div>The weather is <em target>beautiful</em>.</div>', array( 'HTML', 'BODY', 'DIV', 'EM' ), 1 ),
+ 'EM after closed EM' => array( '<em></em><em target></em>', array( 'HTML', 'BODY', 'EM' ), 2 ),
+ 'EM after closed EMs' => array( '<em></em><em><em></em></em><em></em><em></em><em target></em>', array( 'HTML', 'BODY', 'EM' ), 6 ),
+ 'EM after unclosed EM' => array( '<em><em target></em>', array( 'HTML', 'BODY', 'EM', 'EM' ), 1 ),
+ 'EM after unclosed EM after DIV' => array( '<em><div><em target>', array( 'HTML', 'BODY', 'EM', 'DIV', 'EM' ), 1 ),
+ // This should work for all formatting elements, but if two work, the others probably do too.
+ 'CODE after unclosed CODE after DIV' => array( '<code><div><code target>', array( 'HTML', 'BODY', 'CODE', 'DIV', 'CODE' ), 1 ),
+ 'P after unclosed P' => array( '<p><p target>', array( 'HTML', 'BODY', 'P' ), 2 ),
+ 'Unclosed EM inside P after unclosed P' => array( '<em><p><p><em target>', array( 'HTML', 'BODY', 'EM', 'P', 'EM' ), 1 ),
+ 'P after closed P' => array( '<p><i>something</i></p><p target>This one</p>', array( 'HTML', 'BODY', 'P' ), 2 ),
+ 'A after unclosed A' => array( '<a><a target>', array( 'HTML', 'BODY', 'A' ), 2 ),
+ 'A after unclosed A, after a P' => array( '<p><a><a target>', array( 'HTML', 'BODY', 'P', 'A' ), 2 ),
+ // This one adds a test at a deep stack depth to ensure things work for situations beyond short test docs.
+ 'Large HTML document with deep P' => array(
+ '<div><div><div><div><div><div><div><div><p></p><p></p><p><div><strong><em><code></code></em></strong></div></p></div></div></div></div></div></div></div></div><div><div><div><div><div><div><div><div><p></p><p></p><p><div><strong><em><code target></code></em></strong></div></p></div></div></div></div></div></div></div></div>',
+ array( 'HTML', 'BODY', 'DIV', 'DIV', 'DIV', 'DIV', 'DIV', 'DIV', 'DIV', 'DIV', 'DIV', 'STRONG', 'EM', 'CODE' ),
+ 2,
+ ),
+ );
+ }
+
+ /**
+ * Ensures that the ability to set attributes isn't broken by the HTML Processor.
+ *
+ * @since 6.4.0
+ *
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Processor::set_attribute
+ */
+ public function test_can_modify_attributes_after_finding_tag() {
+ $p = WP_HTML_Processor::createFragment( '<div><figure><img><figcaption>test</figcaption></figure>' );
+
+ $this->assertTrue( $p->next_tag( array( 'breadcrumbs' => array( 'figcaption' ) ) ), 'Unable to find given tag.' );
+
+ $p->set_attribute( 'found-it', true );
+ $this->assertSame( '<div><figure><img><figcaption found-it>test</figcaption></figure>', $p->get_updated_html() );
+ }
+
+ /**
+ * Ensures that the ability to scan for a given tag name isn't broken by the HTML Processor.
+ *
+ * @since 6.4.0
+ *
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Processor::next_tag
+ */
+ public function test_can_query_an_element_by_tag_name() {
+ $p = WP_HTML_Processor::createFragment( '<div><DIV><strong><img></strong></DIV>' );
+ $p->next_tag( 'IMG' );
+ $p->set_attribute( 'loading', 'lazy' );
+
+ $this->assertSame( '<div><DIV><strong><img loading="lazy"></strong></DIV>', $p->get_updated_html() );
+ }
+
+ /**
+ * Ensures that basic seeking behavior isn't broken by the HTML Processor.
+ *
+ * @since 6.4.0
+ *
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Processor::seek
+ */
+ public function test_can_seek_back_and_forth() {
+ $p = WP_HTML_Processor::createFragment( '<div><p one><div><p><div two><p><div><p><div><p three>' );
+
+ // Find first tag of interest.
+ while ( $p->next_tag() && null === $p->get_attribute( 'one' ) ) {
+ continue;
+ }
+ $p->set_bookmark( 'first' );
+
+ // Find second tag of interest.
+ while ( $p->next_tag() && null === $p->get_attribute( 'two' ) ) {
+ continue;
+ }
+ $p->set_bookmark( 'second' );
+
+ // Find third tag of interest.
+ while ( $p->next_tag() && null === $p->get_attribute( 'three' ) ) {
+ continue;
+ }
+ $p->set_bookmark( 'third' );
+
+ // Seek backwards.
+ $p->seek( 'first' );
+
+ // Seek forwards. If the current token isn't also updated this could appear like a backwards seek.
+ $p->seek( 'second' );
+ $this->assertTrue( $p->get_attribute( 'two' ) );
+ }
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestshtmlapiwpHtmlSupportRequiredOpenElementsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/html-api/wpHtmlSupportRequiredOpenElements.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/html-api/wpHtmlSupportRequiredOpenElements.php (rev 0)
+++ trunk/tests/phpunit/tests/html-api/wpHtmlSupportRequiredOpenElements.php 2023-07-20 13:41:21 UTC (rev 56274)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,365 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Unit tests for the HTML API indicating that changes are needed to the
+ * WP_HTML_Open_Elements class before specific features are added to the API.
+ *
+ * Note! Duplication of test cases and the helper function in this file are intentional.
+ * This test file exists to warn developers of related areas of code that need to update
+ * together when adding support for new elements to the HTML Processor. For example,
+ * when adding support for the BUTTON element it's necessary to update multiple methods
+ * in the class governing the stack of open elements as well as the HTML Processor class
+ * itself. This is because each element might bring with it semantic rules that impact
+ * the way the document should be parsed. BUTTON creates a kind of boundary in the
+ * DOM tree and implicitly closes existing open BUTTON elements.
+ *
+ * Without these tests a developer needs to investigate all possible places they
+ * might need to update when adding support for more elements and risks overlooking
+ * important parts that, in the absence of the related support, will lead to errors.
+ *
+ * @package WordPress
+ * @subpackage HTML-API
+ *
+ * @since 6.4.0
+ *
+ * @group html-api
+ *
+ * @coversDefaultClass WP_HTML_Processor
+ */
+class Tests_HtmlApi_wpHtmlSupportRequiredOpenElements extends WP_UnitTestCase {
+ /**
+ * Fails to assert if the HTML Processor handles the given tag.
+ *
+ * This test helper is used throughout this test file for one purpose only: to
+ * fail a test if the HTML Processor handles the given tag. In other words, it
+ * ensures that the HTML Processor aborts when encountering the given tag.
+ *
+ * This is used to ensure that when support for a new tag is added to the
+ * HTML Processor it receives full support and not partial support, which
+ * could lead to a variety of issues.
+ *
+ * Do not remove this helper function as it provides semantic meaning to the
+ * assertions in the tests in this file and its behavior is incredibly specific
+ * and limited and doesn't warrant adding a new abstraction into WP_UnitTestCase.
+ *
+ * @param string $tag_name the HTML Processor should abort when encountering this tag, e.g. "BUTTON".
+ */
+ private function ensure_support_is_added_everywhere( $tag_name ) {
+ $p = WP_HTML_Processor::createFragment( "<$tag_name>" );
+
+ $this->assertFalse( $p->step(), "Must support terminating elements in specific scope check before adding support for the {$tag_name} element." );
+ }
+
+ /**
+ * The check for whether an element is in a scope depends on
+ * looking for a number of terminating elements in the stack of open
+ * elements. Until the listed elements are supported in the HTML
+ * processor, there are no terminating elements and there's no
+ * point in taking the time to look for them.
+ *
+ * @since 6.4.0
+ *
+ * @ticket 58517
+ */
+ public function test_has_element_in_scope_needs_support() {
+ // These elements impact all scopes.
+ $this->ensure_support_is_added_everywhere( 'APPLET' );
+ $this->ensure_support_is_added_everywhere( 'CAPTION' );
+ $this->ensure_support_is_added_everywhere( 'HTML' );
+ $this->ensure_support_is_added_everywhere( 'TABLE' );
+ $this->ensure_support_is_added_everywhere( 'TD' );
+ $this->ensure_support_is_added_everywhere( 'TH' );
+ $this->ensure_support_is_added_everywhere( 'MARQUEE' );
+ $this->ensure_support_is_added_everywhere( 'OBJECT' );
+ $this->ensure_support_is_added_everywhere( 'TEMPLATE' );
+
+ // MathML Elements
+ $this->ensure_support_is_added_everywhere( 'MI' );
+ $this->ensure_support_is_added_everywhere( 'MO' );
+ $this->ensure_support_is_added_everywhere( 'MN' );
+ $this->ensure_support_is_added_everywhere( 'MS' );
+ $this->ensure_support_is_added_everywhere( 'MTEXT' );
+ $this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
+
+ /*
+ * SVG elements: note that TITLE is both an HTML element and an SVG element
+ * so care must be taken when adding support for either one.
+ */
+ $this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
+ $this->ensure_support_is_added_everywhere( 'DESC' );
+ $this->ensure_support_is_added_everywhere( 'TITLE' );
+ }
+
+ /**
+ * The check for whether an element is in list item scope depends on
+ * the elements for any scope, plus UL and OL.
+ *
+ * The method for asserting list item scope doesn't currently exist
+ * because the LI element isn't yet supported and the LI element is
+ * the only element that needs to know about list item scope.
+ *
+ * @since 6.4.0
+ *
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Open_Elements::has_element_in_list_item_scope
+ */
+ public function test_has_element_in_list_item_scope_needs_support() {
+ // These elements impact all scopes.
+ $this->ensure_support_is_added_everywhere( 'APPLET' );
+ $this->ensure_support_is_added_everywhere( 'CAPTION' );
+ $this->ensure_support_is_added_everywhere( 'HTML' );
+ $this->ensure_support_is_added_everywhere( 'TABLE' );
+ $this->ensure_support_is_added_everywhere( 'TD' );
+ $this->ensure_support_is_added_everywhere( 'TH' );
+ $this->ensure_support_is_added_everywhere( 'MARQUEE' );
+ $this->ensure_support_is_added_everywhere( 'OBJECT' );
+ $this->ensure_support_is_added_everywhere( 'TEMPLATE' );
+
+ // MathML Elements
+ $this->ensure_support_is_added_everywhere( 'MI' );
+ $this->ensure_support_is_added_everywhere( 'MO' );
+ $this->ensure_support_is_added_everywhere( 'MN' );
+ $this->ensure_support_is_added_everywhere( 'MS' );
+ $this->ensure_support_is_added_everywhere( 'MTEXT' );
+ $this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
+
+ /*
+ * SVG elements: note that TITLE is both an HTML element and an SVG element
+ * so care must be taken when adding support for either one.
+ */
+ $this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
+ $this->ensure_support_is_added_everywhere( 'DESC' );
+ $this->ensure_support_is_added_everywhere( 'TITLE' );
+
+ // These elements are specific to list item scope.
+ $this->ensure_support_is_added_everywhere( 'OL' );
+ $this->ensure_support_is_added_everywhere( 'UL' );
+
+ // This element is the only element that depends on list item scope.
+ $this->ensure_support_is_added_everywhere( 'LI' );
+ }
+
+ /**
+ * The check for whether an element is in BUTTON scope depends on
+ * the elements for any scope, plus BUTTON.
+ *
+ * @since 6.4.0
+ *
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Open_Elements::has_element_in_button_scope
+ */
+ public function test_has_element_in_button_scope_needs_support() {
+ // These elements impact all scopes.
+ $this->ensure_support_is_added_everywhere( 'APPLET' );
+ $this->ensure_support_is_added_everywhere( 'CAPTION' );
+ $this->ensure_support_is_added_everywhere( 'HTML' );
+ $this->ensure_support_is_added_everywhere( 'TABLE' );
+ $this->ensure_support_is_added_everywhere( 'TD' );
+ $this->ensure_support_is_added_everywhere( 'TH' );
+ $this->ensure_support_is_added_everywhere( 'MARQUEE' );
+ $this->ensure_support_is_added_everywhere( 'OBJECT' );
+ $this->ensure_support_is_added_everywhere( 'TEMPLATE' );
+
+ // MathML Elements
+ $this->ensure_support_is_added_everywhere( 'MI' );
+ $this->ensure_support_is_added_everywhere( 'MO' );
+ $this->ensure_support_is_added_everywhere( 'MN' );
+ $this->ensure_support_is_added_everywhere( 'MS' );
+ $this->ensure_support_is_added_everywhere( 'MTEXT' );
+ $this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
+
+ /*
+ * SVG elements: note that TITLE is both an HTML element and an SVG element
+ * so care must be taken when adding support for either one.
+ */
+ $this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
+ $this->ensure_support_is_added_everywhere( 'DESC' );
+ $this->ensure_support_is_added_everywhere( 'TITLE' );
+
+ $this->ensure_support_is_added_everywhere( 'BUTTON' );
+ }
+
+ /**
+ * The optimization maintaining a flag for "P is in BUTTON scope" requires
+ * updating that flag every time an element is popped from the stack of
+ * open elements.
+ *
+ * @since 6.4.0
+ *
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Open_Elements::after_element_pop
+ */
+ public function test_after_element_pop_must_maintain_p_in_button_scope_flag() {
+ // These elements impact all scopes.
+ $this->ensure_support_is_added_everywhere( 'APPLET' );
+ $this->ensure_support_is_added_everywhere( 'CAPTION' );
+ $this->ensure_support_is_added_everywhere( 'HTML' );
+ $this->ensure_support_is_added_everywhere( 'TABLE' );
+ $this->ensure_support_is_added_everywhere( 'TD' );
+ $this->ensure_support_is_added_everywhere( 'TH' );
+ $this->ensure_support_is_added_everywhere( 'MARQUEE' );
+ $this->ensure_support_is_added_everywhere( 'OBJECT' );
+ $this->ensure_support_is_added_everywhere( 'TEMPLATE' );
+
+ // MathML Elements
+ $this->ensure_support_is_added_everywhere( 'MI' );
+ $this->ensure_support_is_added_everywhere( 'MO' );
+ $this->ensure_support_is_added_everywhere( 'MN' );
+ $this->ensure_support_is_added_everywhere( 'MS' );
+ $this->ensure_support_is_added_everywhere( 'MTEXT' );
+ $this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
+
+ /*
+ * SVG elements: note that TITLE is both an HTML element and an SVG element
+ * so care must be taken when adding support for either one.
+ */
+ $this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
+ $this->ensure_support_is_added_everywhere( 'DESC' );
+ $this->ensure_support_is_added_everywhere( 'TITLE' );
+
+ // This element is specific to BUTTON scope.
+ $this->ensure_support_is_added_everywhere( 'BUTTON' );
+ }
+
+ /**
+ * The optimization maintaining a flag for "P is in BUTTON scope" requires
+ * updating that flag every time an element is pushed onto the stack of
+ * open elements.
+ *
+ * @since 6.4.0
+ *
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Open_Elements::after_element_push
+ */
+ public function test_after_element_push_must_maintain_p_in_button_scope_flag() {
+ // These elements impact all scopes.
+ $this->ensure_support_is_added_everywhere( 'APPLET' );
+ $this->ensure_support_is_added_everywhere( 'CAPTION' );
+ $this->ensure_support_is_added_everywhere( 'HTML' );
+ $this->ensure_support_is_added_everywhere( 'TABLE' );
+ $this->ensure_support_is_added_everywhere( 'TD' );
+ $this->ensure_support_is_added_everywhere( 'TH' );
+ $this->ensure_support_is_added_everywhere( 'MARQUEE' );
+ $this->ensure_support_is_added_everywhere( 'OBJECT' );
+ $this->ensure_support_is_added_everywhere( 'TEMPLATE' );
+
+ // MathML Elements
+ $this->ensure_support_is_added_everywhere( 'MI' );
+ $this->ensure_support_is_added_everywhere( 'MO' );
+ $this->ensure_support_is_added_everywhere( 'MN' );
+ $this->ensure_support_is_added_everywhere( 'MS' );
+ $this->ensure_support_is_added_everywhere( 'MTEXT' );
+ $this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
+
+ /*
+ * SVG elements: note that TITLE is both an HTML element and an SVG element
+ * so care must be taken when adding support for either one.
+ */
+ $this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
+ $this->ensure_support_is_added_everywhere( 'DESC' );
+ $this->ensure_support_is_added_everywhere( 'TITLE' );
+
+ $this->ensure_support_is_added_everywhere( 'BUTTON' );
+ }
+
+ /**
+ * The check for whether an element is in TABLE scope depends on
+ * the HTML, TABLE, and TEMPLATE elements.
+ *
+ * @since 6.4.0
+ *
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Open_Elements::has_element_in_table_scope
+ */
+ public function test_has_element_in_table_scope_needs_support() {
+ // These elements impact all scopes.
+ $this->ensure_support_is_added_everywhere( 'APPLET' );
+ $this->ensure_support_is_added_everywhere( 'CAPTION' );
+ $this->ensure_support_is_added_everywhere( 'HTML' );
+ $this->ensure_support_is_added_everywhere( 'TABLE' );
+ $this->ensure_support_is_added_everywhere( 'TD' );
+ $this->ensure_support_is_added_everywhere( 'TH' );
+ $this->ensure_support_is_added_everywhere( 'MARQUEE' );
+ $this->ensure_support_is_added_everywhere( 'OBJECT' );
+ $this->ensure_support_is_added_everywhere( 'TEMPLATE' );
+
+ // MathML Elements
+ $this->ensure_support_is_added_everywhere( 'MI' );
+ $this->ensure_support_is_added_everywhere( 'MO' );
+ $this->ensure_support_is_added_everywhere( 'MN' );
+ $this->ensure_support_is_added_everywhere( 'MS' );
+ $this->ensure_support_is_added_everywhere( 'MTEXT' );
+ $this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
+
+ /*
+ * SVG elements: note that TITLE is both an HTML element and an SVG element
+ * so care must be taken when adding support for either one.
+ */
+ $this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
+ $this->ensure_support_is_added_everywhere( 'DESC' );
+ $this->ensure_support_is_added_everywhere( 'TITLE' );
+
+ // These elements are specific to TABLE scope.
+ $this->ensure_support_is_added_everywhere( 'HTML' );
+ $this->ensure_support_is_added_everywhere( 'TABLE' );
+ $this->ensure_support_is_added_everywhere( 'TEMPLATE' );
+
+ // These elements depend on table scope.
+ $this->ensure_support_is_added_everywhere( 'CAPTION' );
+ $this->ensure_support_is_added_everywhere( 'COL' );
+ $this->ensure_support_is_added_everywhere( 'COLGROUP' );
+ $this->ensure_support_is_added_everywhere( 'TBODY' );
+ $this->ensure_support_is_added_everywhere( 'TD' );
+ $this->ensure_support_is_added_everywhere( 'TFOOT' );
+ $this->ensure_support_is_added_everywhere( 'TH' );
+ $this->ensure_support_is_added_everywhere( 'THEAD' );
+ $this->ensure_support_is_added_everywhere( 'TR' );
+ }
+
+ /**
+ * The check for whether an element is in SELECT scope depends on
+ * the OPTGROUP and OPTION elements.
+ *
+ * @since 6.4.0
+ *
+ * @ticket 58517
+ *
+ * @covers WP_HTML_Open_Elements::has_element_in_select_scope
+ */
+ public function test_has_element_in_select_scope_needs_support() {
+ // These elements impact all scopes.
+ $this->ensure_support_is_added_everywhere( 'APPLET' );
+ $this->ensure_support_is_added_everywhere( 'CAPTION' );
+ $this->ensure_support_is_added_everywhere( 'HTML' );
+ $this->ensure_support_is_added_everywhere( 'TABLE' );
+ $this->ensure_support_is_added_everywhere( 'TD' );
+ $this->ensure_support_is_added_everywhere( 'TH' );
+ $this->ensure_support_is_added_everywhere( 'MARQUEE' );
+ $this->ensure_support_is_added_everywhere( 'OBJECT' );
+ $this->ensure_support_is_added_everywhere( 'TEMPLATE' );
+
+ // MathML Elements
+ $this->ensure_support_is_added_everywhere( 'MI' );
+ $this->ensure_support_is_added_everywhere( 'MO' );
+ $this->ensure_support_is_added_everywhere( 'MN' );
+ $this->ensure_support_is_added_everywhere( 'MS' );
+ $this->ensure_support_is_added_everywhere( 'MTEXT' );
+ $this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
+
+ /*
+ * SVG elements: note that TITLE is both an HTML element and an SVG element
+ * so care must be taken when adding support for either one.
+ */
+ $this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
+ $this->ensure_support_is_added_everywhere( 'DESC' );
+ $this->ensure_support_is_added_everywhere( 'TITLE' );
+
+ // These elements are specific to SELECT scope.
+ $this->ensure_support_is_added_everywhere( 'OPTGROUP' );
+ $this->ensure_support_is_added_everywhere( 'OPTION' );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>