Tag Processor: Add ability to stop at tag closers, if requested #45789
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
adamziel
reviewed
Nov 16, 2022
| @@ -408,7 +439,16 @@ public function next_tag( $query = null ) { | |||
| return false; | |||
| } | |||
|
|
|||
| $this->parse_tag_opener_attributes(); | |||
| while ( $this->parse_next_attribute() ) { | |||
adamziel
reviewed
Nov 16, 2022
Comment on lines
1154
to
1203
| * Example: | ||
| * <code> | ||
| * $p = new WP_HTML_Tag_Processor( '<div></div>' ); | ||
| * $p->next_tag( [ 'tag_name' => 'div', 'tag_closers' => 'visit' ] ); | ||
| * $p->is_tag_closer() === false; | ||
| * | ||
| * $p->next_tag( [ 'tag_name' => 'div', 'tag_closers' => 'visit' ] ); | ||
| * $p->iss_tag_closer() === true; | ||
| * </code> |
There was a problem hiding this comment.
Nice example! A minor typo:
Suggested change
| * Example: | |
| * <code> | |
| * $p = new WP_HTML_Tag_Processor( '<div></div>' ); | |
| * $p->next_tag( [ 'tag_name' => 'div', 'tag_closers' => 'visit' ] ); | |
| * $p->is_tag_closer() === false; | |
| * | |
| * $p->next_tag( [ 'tag_name' => 'div', 'tag_closers' => 'visit' ] ); | |
| * $p->iss_tag_closer() === true; | |
| * </code> | |
| * Example: | |
| * <code> | |
| * $p = new WP_HTML_Tag_Processor( '<div></div>' ); | |
| * $p->next_tag( [ 'tag_name' => 'div', 'tag_closers' => 'visit' ] ); | |
| * $p->is_tag_closer() === false; | |
| * | |
| * $p->next_tag( [ 'tag_name' => 'div', 'tag_closers' => 'visit' ] ); | |
| * $p->is_tag_closer() === true; | |
| * </code> |
adamziel
reviewed
Nov 16, 2022
| $p->next_tag( [ 'tag_name' => 'div', 'tag_closers' => 'visit' ] ); | ||
| $this->assertFalse( $p->is_tag_closer(), 'Indicated a tag opener is a tag closer' ); | ||
| $this->assertTrue( $p->next_tag( [ 'tag_name' => 'div', 'tag_closers' => 'visit' ] ), 'Did not stop at desired tag closer' ); | ||
| $this->assertTrue( $p->is_tag_closer(), 'Indicated a tag closer is a tag opener' ); |
There was a problem hiding this comment.
I'd like to see some tests to confirm the behavior of the other methods in the tag closer state, e.g. update_attribute(), __toString(), etc
There was a problem hiding this comment.
added a test to confirm that ops are inert inside closed tags
|
This looks good @dmsnell! There are some conflicts and I left a few comments, but the direction is great. |
dmsnell
force-pushed
the
tag-processor/stop-at-tag-closers
branch
2 times, most recently
from
46e906e
to
1652965
Compare
dmsnell
force-pushed
the
tag-processor/stop-at-tag-closers
branch
2 times, most recently
from
5e96d70
to
8bc31a3
Compare
|
Fixed the lint issues |
dmsnell
force-pushed
the
tag-processor/stop-at-tag-closers
branch
from
8bc31a3
to
0d78f1d
Compare
`WP_HTML_Tag_Processor` introduces the ability to walk through an HTML document and modify attributes on tag openers. At times it could be useful to stop also at tag closers in order to perform augmented inspection and querying of a document. In this patch we're opening up a mode that allows just that; if querying with the `[ "tag_closers" => "visit" ]` query parrameter then in addition to stopping at tag openers, this will allow stopping at all tag tokens regardless of open or close status.
dmsnell
force-pushed
the
tag-processor/stop-at-tag-closers
branch
from
0d78f1d
to
7e76592
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Notes
What?
Add an option to the
WP_HTML_Tag_Processorquery to indicate that the processor should stop and visit tag closers while walking through the input document.Why?
WP_HTML_Tag_Processorintroduces the ability to walk through an HTML document and modify attributes on tag openers.At times it could be useful to stop also at tag closers in order to perform augmented inspection and querying of a document.
In this patch we're opening up a mode that allows just that; if querying with the
[ "tag_closers" => "visit" ]query parrameter then in addition to stopping at tag openers, this will allow stopping at all tag tokens regardless of open or close status.How?
Introduces internal mechanics to detect and stop at tag closers.
Exposes new query option
"tag_closers" => "visit" | "skip"to pass intonext_tag()which indicates whether or not to stop at tag closers.Exposes new
is_tag_closer()method to determine if current tag is an opener or closer (from calling code).Testing Instructions
Review the new unit tests to confirm behavior.