HTML API: Use create_fragment_at_node to allow more contexts in create_fragment #7777

sirreal · 2024-11-12T14:51:44Z

✅ ~~This PR builds on (and requires) #7348.~~

This modifies ::create_fragment( $html, $context ) to use a full processor and create_fragment_at_node instead of the other way around. This makes more sense and makes the main factory methods more clear, where the state required for fragments is set up in create_fragment_at_node instead of in both create_fragment and create_fragment_at_current_node.

This allows for more HTML contexts to be provided to the basic create_fragment where the provided context HTML is appended to <!DOCTYPE html>, a full processor is created, the last tag opener is found, and a fragment parser is created at that node via create_fragment_at_current_node.

The HTML5lib tests are updated accordingly to use this new method to create fragments.

Trac ticket: https://core.trac.wordpress.org/ticket/62584
(previously https://core.trac.wordpress.org/ticket/62357)

Closes #7141.

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

…umbs

This reverts commit ba9e218.

null should not be returned in this case, but it is part of the signature and should be covered here.

…i/use-create-fragment-at-node-for-main-create-fragment-method

github-actions · 2024-11-12T15:03:52Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Inspired by WordPress#7141 Co-authored-by: Dennis Snell <[email protected]>

sirreal · 2024-11-21T18:57:20Z

I've pulled some valuable changes like tests and documentation from #7141 into this PR.

github-actions · 2024-11-21T19:22:27Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props jonsurrell, dmsnell, bernhard-reiter.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

sirreal · 2024-11-21T19:26:38Z

#7348 has landed. I've merged trunk, added some improvements like tests and _doing_it_wrong from #7141.

I'm opening this up for review now 🎉

ockham · 2024-11-25T15:07:35Z

The PR says that there are currently conflicts; would you mind rebasing this? 😊

…in-create-fragment-method

sirreal · 2024-11-25T15:18:25Z

Branch is up-to-date and should be conflict free now 👍

ockham · 2024-11-27T10:35:21Z

Branch is up-to-date and should be conflict free now 👍

Conflicting again now 🙈 Mind rebasing once again? 😅 I'll review today.

…in-create-fragment-method

ockham

LGTM, thank you 👍

I love how this re-organizes the code in create_fragment and create_fragment_at_current_node.

I'll commit this once CI is green. Do you want to open a separate ticket for this? Otherwise, I can do a "See #62357" (instead of a "Fixes #..."). It might be a big enough change to warrant a ticket of its own though 🙂

sirreal · 2024-11-27T11:50:36Z

I'll create a dedicated ticket for this. It's a very logical step after #7348, but does introduce a new feature and is a significant refactor.

sirreal · 2024-11-27T11:58:18Z

I've created and linked ticket https://core.trac.wordpress.org/ticket/62584.

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

Co-authored-by: Bernie Reiter <[email protected]>

ockham · 2024-11-27T14:34:42Z

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

sirreal added 28 commits October 11, 2024 10:21

Add spawn_fragment_parser method

d8ac361

Fix the processor context_node

ad8f8db

Make it public

e2efee4

Fix spawn_fragment_parser method

4f5249c

Process non-body context tests

eaed863

Handle all the different document context in html5lib tests

25b18fa

lints

9ac142f

Merge branch 'trunk' into html-api/add-spawn-fragment-parser-method

9ede14f

Make spawned fragment parse have HTML > [context-node-tag] in breadcr…

3f35886

…umbs

Fallback to context node when checking namespace

ba9e218

Add tests

fe48fa5

Set the form element pointer on the fragment parser

fa4c5cb

Merge branch 'trunk' into html-api/add-spawn-fragment-parser-method

fbb5c2f

Merge branch 'trunk' into html-api/add-spawn-fragment-parser-method

336050d

Revert "Fallback to context node when checking namespace"

943bbdd

This reverts commit ba9e218.

Fix initial namespace on integration nodes

e3a0a86

Merge branch 'trunk' into html-api/add-spawn-fragment-parser-method

9d3b318

Rename method, use static constructor, add comments

27a9781

Update method name in tests

0789538

Add ticket to tests

5e8b82e

Merge branch 'trunk' into html-api/add-spawn-fragment-parser-method

7eeec27

Update method name in html5lib tests

37f9ff4

Handle null return from create_fragment

80ae6f2

null should not be returned in this case, but it is part of the signature and should be covered here.

Use a cloned copy of the FORM element from the parent processor

9866402

Use create_fragement_at_node internally in create_fragment

00ed28c

Use create_fragment_at_node internally in create_fragment

c247869

Remove stale comment

bcebeba

Merge branch 'html-api/add-spawn-fragment-parser-method' into html-ap…

9904524

…i/use-create-fragment-at-node-for-main-create-fragment-method

sirreal mentioned this pull request Nov 12, 2024

HTML API: Allow additional fragment contexts. #7141

Closed

2 tasks

sirreal and others added 7 commits November 21, 2024 16:35

Remove redundant early initialization of processor var

f9b5bea

Pass encoding from context into full processor

48e4738

Update comments, remove "only <body> context" mentions

479c0b3

Improve documentation for create_fragment

ed3bb54

Inspired by WordPress#7141 Co-authored-by: Dennis Snell <[email protected]>

Add tests for unsupported contexts

d2e4814

Inspired by WordPress#7141 Co-authored-by: Dennis Snell <[email protected]>

Add _doing_it_wrong messages

3412256

Move fragment tests into the fragment test suite

f391255

sirreal marked this pull request as ready for review November 21, 2024 19:22

Restore better comment from trunk

75da0cc

Merge branch 'trunk' into html-api/use-create-fragment-at-node-for-ma…

72e2c19

…in-create-fragment-method

sirreal added 3 commits November 27, 2024 12:30

Merge branch 'trunk' into html-api/use-create-fragment-at-node-for-ma…

719dfe0

…in-create-fragment-method

Check seeking to final_node success

1461534

Merge branch 'trunk' into html-api/use-create-fragment-at-node-for-ma…

f1ba41c

…in-create-fragment-method

ockham approved these changes Nov 27, 2024

View reviewed changes

ockham reviewed Nov 27, 2024

View reviewed changes

tests/phpunit/tests/html-api/wpHtmlProcessorFragmentParsing.php Outdated Show resolved Hide resolved

ockham reviewed Nov 27, 2024

View reviewed changes

tests/phpunit/tests/html-api/wpHtmlProcessorFragmentParsing.php Outdated Show resolved Hide resolved

sirreal commented Nov 27, 2024

View reviewed changes

tests/phpunit/tests/html-api/wpHtmlProcessorFragmentParsing.php Outdated Show resolved Hide resolved

Update ticket numbers

d6d5305

Co-authored-by: Bernie Reiter <[email protected]>

ockham closed this Nov 27, 2024

sirreal deleted the html-api/use-create-fragment-at-node-for-main-create-fragment-method branch November 27, 2024 15:13

dmsnell mentioned this pull request Sep 23, 2025

Coherent story for HTML-setting methods whatwg/html#11669

Open

HTML API: Use create_fragment_at_node to allow more contexts in create_fragment #7777

HTML API: Use create_fragment_at_node to allow more contexts in create_fragment #7777

Uh oh!

Conversation

sirreal commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Nov 12, 2024

Test using WordPress Playground

Some things to be aware of

Uh oh!

sirreal commented Nov 21, 2024

Uh oh!

github-actions bot commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sirreal commented Nov 21, 2024

Uh oh!

ockham commented Nov 25, 2024

Uh oh!

sirreal commented Nov 25, 2024

Uh oh!

ockham commented Nov 27, 2024

Uh oh!

ockham left a comment

Choose a reason for hiding this comment

Uh oh!

sirreal commented Nov 27, 2024

Uh oh!

sirreal commented Nov 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ockham commented Nov 27, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sirreal commented Nov 12, 2024 •

edited

Loading

github-actions bot commented Nov 21, 2024 •

edited

Loading

sirreal commented Nov 27, 2024 •

edited

Loading