Docs: Prevent class name mismatch in deprecated blocks by defining apiVersion#70713
Docs: Prevent class name mismatch in deprecated blocks by defining apiVersion#70713shrivastavanolo wants to merge 1 commit intoWordPress:trunkfrom
Conversation
shrivastavanolo
requested review from
ajitbohra,
fabiankaegy,
juanmaguitar and
ndiego
as code owners
|
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
1 similar comment
|
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
shrivastavanolo
force-pushed
the
docs/update-block-deprecation
branch
from
86e8bae to
dfdd5fe
Compare
2 participants
What?
See #70123
This PR updates the block deprecation documentation to clarify that deprecated block entries should explicitly define
apiVersionto avoid unexpected behavior.Why?
If
apiVersionis not defined or is less than 1 in a deprecated block, Gutenberg applies theblocks.getSaveContent.extraPropsfilter, which may add extra class names (e.g.,wp-block-{block-name}oris-loading) during serialization. These are often not present in the original saved content, leading to mismatches that prevent the deprecation logic from triggering correctly.How?
The documentation now includes a new section explaining this behavior and recommending that
apiVersionbe explicitly set in eachdeprecatedentry. An example is provided to illustrate how this prevents mismatches and ensures proper block validation and migration.