Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Block Hooks: Try Streaming Parser #8006

Draft
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

ockham
Copy link
Contributor

@ockham ockham commented Dec 16, 2024

Longer-term experiment, based on #5753. Currently just copying over code from that PR. More to come 😬

With the introduction of apply_block_hooks_to_content() in WP 6.6, which in 6.7 became the main entry point for Block Hooks across the board — regardless of whether applied to templates, patterns, Navigation blocks, or Post Content, it has become easier to swap out the existing Block Hooks implementation (which requires parsing the block markup into a tree, which is then traversed and re-serialized) for a streaming parser.

Block Hooks are fairly exhaustively covered by unit tests, but a large number of those tests covers lower-level functions that operate at block tree level. In order for this experiment to become viable, we will need to replace them with something that operates directly on block markup level -- see the below roadmap.

Roadmap:

  • Plug inject_hooked_blocks_into_content into apply_block_hooks_to_content (to replace the existing block tree traversal based implementation with it).
  • Fix failing unit tests.
  • Take note of now-obsolete lower-level functions that are no longer invoked as part of the callstack of apply_block_hooks_to_content. Analyze what they're doing, and replace them with tests that cover apply_block_hooks_to_content to ensure equivalent behavior.

Trac ticket:


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.

@ockham ockham self-assigned this Dec 16, 2024
@ockham
Copy link
Contributor Author

ockham commented Dec 16, 2024

Noting that #6760 might come in handy for this.

Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant