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

Timestamp:

12/13/2023 05:51:42 PM (3 years ago)

Author:

Bernhard Reiter

Message:

HTML API: Add support for H1-H6 elements in the HTML Processor.

Previously these have been unsupported, but in this patch, support is added for the tags so that the HTML Processor can process documents containing them.

There was a design discussion about introducing a constant to communicate "any of the H1 - H6 elements" but this posed a number of challenges that don't need to be answered in this patch. For the time being, because the HTML specification treats H1 - H6 specially as a single kind of element, the HTML Processor uses an internal hard-coded string to indicate this. By using a hard-coded string it's possible to avoid introducing a class constant which cannot be made private due to PHP's class design. In the future, this will probably appear as a special constant in a new constant-containing class.

Props dmsnell, jonsurrell.
Fixes #60060.

File:

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

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

@@ -103 +103 @@
  *  - Form elements: BUTTON, FIELDSET, SEARCH.
  *  - Formatting elements: B, BIG, CODE, EM, FONT, I, SMALL, STRIKE, STRONG, TT, U.
- *  - Heading elements: HGROUP.
+ *  - Heading elements: H1, H2, H3, H4, H5, H6, HGROUP.
  *  - Links: A.
  *  - Lists: DL.
@@ -696 +696 @@
                                 }
                                 $this->state->stack_of_open_elements->pop_until( $tag_name );
+                                return true;
+
+                        /*
+                         * > A start tag whose tag name is one of: "h1", "h2", "h3", "h4", "h5", "h6"
+                         */
+                        case '+H1':
+                        case '+H2':
+                        case '+H3':
+                        case '+H4':
+                        case '+H5':
+                        case '+H6':
+                                if ( $this->state->stack_of_open_elements->has_p_in_button_scope() ) {
+                                        $this->close_a_p_element();
+                                }
+
+                                if (
+                                        in_array(
+                                                $this->state->stack_of_open_elements->current_node()->node_name,
+                                                array( 'H1', 'H2', 'H3', 'H4', 'H5', 'H6' ),
+                                                true
+                                        )
+                                ) {
+                                        // @TODO: Indicate a parse error once it's possible.
+                                        $this->state->stack_of_open_elements->pop();
+                                }
+
+                                $this->insert_html_element( $this->state->current_token );
+                                return true;
+
+                        /*
+                         * > An end tag whose tag name is one of: "h1", "h2", "h3", "h4", "h5", "h6"
+                         */
+                        case '-H1':
+                        case '-H2':
+                        case '-H3':
+                        case '-H4':
+                        case '-H5':
+                        case '-H6':
+                                if ( ! $this->state->stack_of_open_elements->has_element_in_scope( '(internal: H1 through H6 - do not use)' ) ) {
+                                        /*
+                                         * This is a parse error; ignore the token.
+                                         *
+                                         * @TODO: Indicate a parse error once it's possible.
+                                         */
+                                        return $this->step();
+                                }
+
+                                $this->generate_implied_end_tags();
+
+                                if ( $this->state->stack_of_open_elements->current_node()->node_name !== $tag_name ) {
+                                        // @TODO: Record parse error: this error doesn't impact parsing.
+                                }
+
+                                $this->state->stack_of_open_elements->pop_until( '(internal: H1 through H6 - do not use)' );
                                 return true;