Skip to content

Docs: Add "Migrating Blocks for iframe Editor Compatibility" page #73778

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.

Sign up for GitHub

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

Jump to bottom
Merged
t-hamano merged 2 commits into from
Dec 8, 2025
Merged

Docs: Add "Migrating Blocks for iframe Editor Compatibility" page #73778

t-hamano merged 2 commits into from
Dec 8, 2025

Conversation

@t-hamano
Copy link
Contributor

@t-hamano t-hamano commented Dec 5, 2025 •
edited
Loading

The first iteration of #73138

What? Why?

While this is not yet certain, in WordPress 7.0, the post editor will always run as an iframe.

This PR adds clear documentation to help block developers test their blocks in the iframe editor beforehand and resolve any technical concerns.

I hope to use this documentation as a starting point and consider updating it as needed based on developer feedback.

cc @annezazu

Note: I plan to update the link that the browser console warning points to with this new documentation link and ship it with 6.9.1.

How?

I have created a subpage of the "API Versions" page, consolidating the following three resources onto one page:

Testing Instructions

Please check the following two pages. If any sections are inappropriate or incorrect, please feel free to push changes.

@t-hamano t-hamano force-pushed the docs/block-v3-migrations branch from f18457e to b7901dc Compare December 5, 2025 08:26
@t-hamano t-hamano force-pushed the docs/block-v3-migrations branch from b7901dc to e87a2cd Compare December 5, 2025 08:31
@t-hamano t-hamano self-assigned this Dec 5, 2025
@t-hamano t-hamano added the [Type] Developer Documentation Documentation for developers label Dec 5, 2025
@t-hamano t-hamano marked this pull request as ready for review December 5, 2025 08:34
@github-actions
Copy link

github-actions bot commented Dec 5, 2025 •
edited
Loading

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.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: t-hamano <[email protected]>
Co-authored-by: youknowriad <[email protected]>
Co-authored-by: Mamaduka <[email protected]>

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

youknowriad
youknowriad approved these changes Dec 5, 2025
View reviewed changes
Copy link
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great guide.

Mamaduka
Mamaduka approved these changes Dec 5, 2025
View reviewed changes
Copy link
Member

@Mamaduka Mamaduka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work, @t-hamano!

We can expand migration examples as needed and cover more common cases.

P.S. To support this effort and improve documentation, I wonder if a call for testing would be helpful? Maybe folks can share their blocks that fail with iframe, and we can provide public examples for migration. Later included in docs.

cc @annezazu

@t-hamano
Copy link
Contributor Author

t-hamano commented Dec 8, 2025

Thanks for your reviews, everyone! Let's continually improve the documentation based on consumers' feedback.

@github-actions
Copy link

github-actions bot commented Dec 8, 2025

Flaky tests detected in e8bb825.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/20023948265
📝 Reported issues:

@t-hamano t-hamano merged commit 06ee224 into trunk Dec 8, 2025
33 checks passed
@t-hamano t-hamano deleted the docs/block-v3-migrations branch December 8, 2025 10:40
@github-actions github-actions bot added this to the Gutenberg 22.3 milestone Dec 8, 2025
@t-hamano t-hamano mentioned this pull request Dec 8, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Mamaduka Mamaduka Mamaduka approved these changes

@youknowriad youknowriad youknowriad approved these changes

@ellatrix ellatrix Awaiting requested review from ellatrix

@stokesman stokesman Awaiting requested review from stokesman

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

@juanmaguitar juanmaguitar Awaiting requested review from juanmaguitar juanmaguitar is a code owner

@fabiankaegy fabiankaegy Awaiting requested review from fabiankaegy fabiankaegy is a code owner

Assignees

@t-hamano t-hamano

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Milestone

Gutenberg 22.3

Development

Successfully merging this pull request may close these issues.

4 participants

@t-hamano @Mamaduka @youknowriad