Size Change: +3 B (0%)

Total Size: 1.91 MB

_{compressed-size-action}

One concern is that if the @wordpress/blocks package containing this PR is released and developers update to the new version, it could have a major impact on their CI. If they are using the registerBlockType() in their unit tests and don't define apiVersion: 3, their CI may fail with a browser warning.

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 <wildworks@git.wordpress.org>
Co-authored-by: fabiankaegy <fabiankaegy@git.wordpress.org>
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Co-authored-by: jsnajdr <jsnajdr@git.wordpress.org>
Co-authored-by: youknowriad <youknowriad@git.wordpress.org>

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

To make all unit tests pass, we need to suppress the warnings by adding apiVersion:3 to all registerBlockType(). However, since I realized I would have to do this for a huge number of instances, I created a configuration file to mock @wordpress/warning.

If we could make API version 3 the default, we wouldn't need this mock 🤔 See #70750 (comment)

I think making API version 3 the default might count as a breaking change, since it might break plugins that aren't compatible with iframed editors.

I do think we should make it default as well.

I do think we should make it default as well.

I believe this was discussed here also but it would be a breaking change since there are many blocks out there that don't specify an apiVersion. So changing the default would potentially break all of these 🤔

yes, maybe something that should happen later after this log is out there. Should we clarify that in the logged message too?

We may be able to migrate in stages.

Since the default API version for blocks without an explicitly defined apiVersion became 1 by #70750, many developers will see browser warnings in WP 6.9 once this PR is merged.

We might be able to push the default API version to 3 in WP 7.0, taking into account developer feedback we'll get on WP 6.9.

P.S. As a follow-up, I plan to disallow anything other than 3 in the block.json schema, just like theme.json.

Flaky tests detected in 57f5487.
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/16719990172
📝 Reported issues:

• [Flaky Test] Redirection after template creation #60678 in /test/e2e/specs/site-editor/site-editor-url-navigation.spec.js

@Mamaduka Thanks for the review!

It would be nice to improve and place the migration guide in the block editor handbook, instead of linking to the make post

I agree. I've added it as one of the tasks on the list at the bottom here: #70743 (comment)

I noticed that the Widget Area block is running in version 1, which is causing the browser warning. This block is very specific, but I'll try to see if we can migrate it to version 3.