WIP: HTML API: Add support for H1-H6 elements in HTML Processor #5535

dmsnell · 2023-10-19T20:40:06Z

Adds support for handling H1 - H6 elements in the HTML Processor.

Verified that these heading elements convey no special rules in other parts of the HTML spec. The definitions within IN BODY processing seem sufficient. For example, there's no mention about special handling in another section about them.
Write positive-affirming tests for heading element support.

ockham · 2023-11-20T10:31:23Z

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

@@ -2409,8 +2410,31 @@ private function matches() {
 			return false;
 		}

+


Suggested change

b/c Coding Standards, see inline GHA warning

… elements.

use an internal private special string. Co-authored-by: Jon Surrell <jon.surrell@automattic.com>

- Add support for H1 - H6 elements (WordPress/wordpress-develop#5535)

…b tests.

ockham · 2023-12-13T15:41:21Z

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

+			case '-H4':
+			case '-H5':
+			case '-H6':
+				if ( ! $this->state->stack_of_open_elements->has_element_in_scope( '(internal: H1 through H6 - do not use)' ) ) {


As an alternative to the string literal, we could spell out the whole list

Suggested change

if ( ! $this->state->stack_of_open_elements->has_element_in_scope( '(internal: H1 through H6 - do not use)' ) ) {

if (

! $this->state->stack_of_open_elements->has_element_in_scope( 'H1' ) &&

! $this->state->stack_of_open_elements->has_element_in_scope( 'H2' ) &&

/* etc */

) {

thank you. as we discussed, I think this is going to be very difficult to do in practice for now, specifically because of the pop_until() behavior. using each element individually requires looping in a way that we don't need to do. I'd prefer we leave this a bit awkward internally for now until we have a better solution that doesn't tradeoff efficiency to get there.

ockham · 2023-12-13T15:44:31Z

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

+					// @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)' );


This one's a bit trickier than the other one; we could change pop_until's signature to accept either a string or an array.

see above: if we don't need array passing I'd prefer that so we can avoid creating the array

ockham

Left two notes suggesting an alternative that would avoid the string literal; but since it's only internal, I don't consider it a blocker.

LGTM 👍

ockham · 2023-12-13T15:53:02Z

src/wp-includes/html-api/class-wp-html-open-elements.php

@@ -106,7 +106,6 @@ public function current_node() {
 	 *
 	 * @see https://html.spec.whatwg.org/#has-an-element-in-the-specific-scope
 	 *
-	 * @param string   $tag_name         Name of tag check.


Oh, I missed this; this looks accidental, no?

yeah, thanks. Not sure what happened here.
added back in 6400821

ockham

Ah, almost missed a little glitch: https://github.com/WordPress/wordpress-develop/pull/5535/files#r1425555165

ockham · 2023-12-13T15:57:30Z

tests/phpunit/tests/html-api/wpHtmlProcessorSemanticRulesHeadingElements.php

+	 *
+	 * @ticket 60060
+	 *
+	 * @covers WP_HTML_Processor::step


Isn't it next_tag we're using here?

more specifically this is covering the semantic rules inside step 🤷‍♂️

ockham · 2023-12-13T15:59:21Z

tests/phpunit/tests/html-api/wpHtmlProcessorSemanticRulesHeadingElements.php

+
+	/**
+	 * Verifies that H1 through H6 elements close an open H1 through H6 element.
+	 *


Missing @ticket and @covers:

Suggested change

*

*

* @ticket 60060

*

* @covers WP_HTML_Processor::next_tag

*

added in 4772a7d

…eadcrumb tests.

ockham · 2023-12-13T17:54:09Z

Committed to Core in https://core.trac.wordpress.org/changeset/57186/.

- Add support for H1 - H6 elements (WordPress/wordpress-develop#5535)

Updates from WordPress/wordpress-develop at 54a09a7ec99c59b8e640bd5aacebfdbf03bb02cc - WordPress/wordpress-develop#5535 Adds support for H1 - H6 elements in the HTML Processor. - WordPress/wordpress-develop#5725 Pause the Tag Processor when reaching the end of the document inside an incomplete syntax element. - Incorporates linting changes from "TODO:" to "todo" This patch adds the blanket exclusion from the HTML API compatability layer after they were removed and started blocking updates from Core. The PHP files in the compatability layer are merged and maintained in the Core repo and all changes or updates need to happen first in Core and then be brought over to Gutenberg as built files. From Gutenberg's perspective they are no different than NPM packages. Co-authored-by: Anton Vlasenko <43744263+anton-vlasenko@users.noreply.github.com> Co-authored-by: Bernie Reiter <96308+ockham@users.noreply.github.com>

Updates from WordPress/wordpress-develop at 54a09a7ec99c59b8e640bd5aacebfdbf03bb02cc - WordPress/wordpress-develop#5535 Adds support for H1 - H6 elements in the HTML Processor. - WordPress/wordpress-develop#5725 Pause the Tag Processor when reaching the end of the document inside an incomplete syntax element. - Incorporates linting changes from "TODO:" to "todo". - WordPress/wordpress-develop#5762 Handles the "all other tags" rules in IN BODY insertion mode. - WordPress/wordpress-develop#5539 Adds support for list elements in the HTML Processor. This patch adds the blanket exclusion from the HTML API compatability layer after they were removed and started blocking updates from Core. The PHP files in the compatability layer are merged and maintained in the Core repo and all changes or updates need to happen first in Core and then be brought over to Gutenberg as built files. From Gutenberg's perspective they are no different than NPM packages. Co-authored-by: Anton Vlasenko <43744263+anton-vlasenko@users.noreply.github.com> Co-authored-by: Bernie Reiter <96308+ockham@users.noreply.github.com>

dmsnell force-pushed the html-api/add-support-for-h1-h6 branch from 81ef71d to 9c8dc13 Compare October 19, 2023 20:41

dmsnell mentioned this pull request Oct 20, 2023

HTML API: Add support for group of containers including ARTICLE element #5538

Closed

dmsnell force-pushed the html-api/add-support-for-h1-h6 branch from 8d853f2 to 415ba5b Compare November 16, 2023 00:24

ockham reviewed Nov 20, 2023

View reviewed changes

dmsnell added 4 commits December 13, 2023 13:27

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

8a2a4f6

Add more tests verifying that the H1-H6 elements close opened heading…

8d2f232

… elements.

Add positive identification tests

f93ef13

Move class constant into Tag Processor, match with it, and add tests

6b45967

dmsnell force-pushed the html-api/add-support-for-h1-h6 branch from e8c4704 to 6b45967 Compare December 13, 2023 12:36

dmsnell and others added 3 commits December 13, 2023 13:57

Remove the class constant to defer design questions for later.

da446c9

use an internal private special string. Co-authored-by: Jon Surrell <jon.surrell@automattic.com>

fixup! Remove the class constant to defer design questions for later.

c1a880f

Add ticket reference

7e9439e

dmsnell marked this pull request as ready for review December 13, 2023 13:28

dmsnell added 3 commits December 13, 2023 14:35

Move H1 - H6 tests into their own semantic rules file.

e0d370c

Illustrate more edge cases for H1 - H6 in the breadcrumb tests.

ed98e7c

fixup! Illustrate more edge cases for H1 - H6 in the breadcrumb tests.

bf7a132

dmsnell mentioned this pull request Dec 13, 2023

HTML API: Backport updates from Core WordPress/gutenberg#57022

Merged

dmsnell added a commit to WordPress/gutenberg that referenced this pull request Dec 13, 2023

HTML API: Backport updates from Core

43b9a9c

- Add support for H1 - H6 elements (WordPress/wordpress-develop#5535)

fixup! fixup! Illustrate more edge cases for H1 - H6 in the breadcrum…

4b8989a

…b tests.

ockham reviewed Dec 13, 2023

View reviewed changes

ockham approved these changes Dec 13, 2023

View reviewed changes

ockham reviewed Dec 13, 2023

View reviewed changes

ockham requested changes Dec 13, 2023

View reviewed changes

ockham reviewed Dec 13, 2023

View reviewed changes

dmsnell added 2 commits December 13, 2023 18:18

fixup! fixup! fixup! Illustrate more edge cases for H1 - H6 in the br…

6400821

…eadcrumb tests.

Add missing test @Covers and @ticket number

4772a7d

ockham approved these changes Dec 13, 2023

View reviewed changes

ockham closed this Dec 13, 2023

dmsnell deleted the html-api/add-support-for-h1-h6 branch December 13, 2023 17:59

dmsnell added a commit to WordPress/gutenberg that referenced this pull request Dec 14, 2023

HTML API: Backport updates from Core (#57022)

2c8de78

- Add support for H1 - H6 elements (WordPress/wordpress-develop#5535)

dmsnell added a commit to WordPress/gutenberg that referenced this pull request Dec 20, 2023

HTML API: Backport updates from Core (#57022)

2310775

- Add support for H1 - H6 elements (WordPress/wordpress-develop#5535)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: HTML API: Add support for H1-H6 elements in HTML Processor #5535

WIP: HTML API: Add support for H1-H6 elements in HTML Processor #5535

dmsnell commented Oct 19, 2023 •

edited

Loading

ockham Nov 20, 2023

ockham Dec 13, 2023

dmsnell Dec 13, 2023

ockham Dec 13, 2023

dmsnell Dec 13, 2023

ockham left a comment

ockham Dec 13, 2023

dmsnell Dec 13, 2023

ockham left a comment

ockham Dec 13, 2023

dmsnell Dec 13, 2023

ockham Dec 13, 2023

dmsnell Dec 13, 2023

ockham commented Dec 13, 2023

		@@ -2409,8 +2410,31 @@ private function matches() {
		return false;
		}

-				if ( ! $this->state->stack_of_open_elements->has_element_in_scope( '(internal: H1 through H6 - do not use)' ) ) {
+				if (
+					! $this->state->stack_of_open_elements->has_element_in_scope( 'H1' ) &&
+					! $this->state->stack_of_open_elements->has_element_in_scope( 'H2' ) &&
+					/* etc */
+				) {

WIP: HTML API: Add support for H1-H6 elements in HTML Processor #5535

WIP: HTML API: Add support for H1-H6 elements in HTML Processor #5535

Conversation

dmsnell commented Oct 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ockham left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ockham left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ockham commented Dec 13, 2023

dmsnell commented Oct 19, 2023 •

edited

Loading