Skip to content

Fix broken editor when passing attributes as undefined or null and add warning for block authors #73149

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

Merged
merged 8 commits into from
Nov 20, 2025
Merged

Fix broken editor when passing attributes as undefined or null and add warning for block authors #73149

Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
82e6464
Ensure attributes is always an object, never null or undefined
jeryj Nov 10, 2025
43a1493
Revert setting empty attributes object in favor of warning within reg…
jeryj Nov 13, 2025
1c1fee6
Revert "Revert setting empty attributes object in favor of warning wi…
jeryj Nov 20, 2025
e67d081
Add warning when passing attributes as undefined and inform that this…
jeryj Nov 20, 2025
d7c5041
Update warning message
jeryj Nov 20, 2025
2a06573
Add unit tests for block registration with undefined, null, or no att…
jeryj Nov 20, 2025
99c3dbb
Use it to avoid duplication in unit test
jeryj Nov 20, 2025
ac10381
Remove temporary messaging about the fix being removed
jeryj Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions packages/blocks/src/store/process-block-type.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,19 @@ export const processBlockType =
),
};

// Temporary fix to allow block authors time to fix blocks that register attributes as null or undefined.
Copy link
Member

@tyxla tyxla Nov 20, 2025

Choose a reason for hiding this comment

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

Doesn't have to be temporary. Folks might encounter this in the future, too.

Copy link
Contributor Author

@jeryj jeryj Nov 20, 2025

Choose a reason for hiding this comment

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

I'm fine with it not being temporary if others agree. I'd defer to folks with more expertise in block registration first.

if (
! blockType.attributes ||
typeof blockType.attributes !== 'object'
) {
warning(
Copy link
Member

@tyxla tyxla Nov 20, 2025

Choose a reason for hiding this comment

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

Can we also include a test for this?

'The block "' +
name +
'" must not register attributes as `null` or `undefined`. Use an empty object (`attributes: {}`) or exclude the `attributes` key. In the next Gutenberg release, passing `null` or `undefined` for `attributes` will cause the block editor to crash.'
Copy link
Member

@tyxla tyxla Nov 20, 2025

Choose a reason for hiding this comment

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

Also, this "in the next release it will crash", isn't accurate, is it? I think we can omit that whole sentence.

Copy link
Contributor Author

@jeryj jeryj Nov 20, 2025

Choose a reason for hiding this comment

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

I wasn't sure. I figured having it be the most aggressive and then relaxing it would be better than starting with a longer timeline.

Copy link
Member

@tyxla tyxla Nov 20, 2025

Choose a reason for hiding this comment

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

But it's technically not true, is it? I'd just remove it and keep the warning forever.

Copy link
Contributor Author

@jeryj jeryj Nov 20, 2025

Choose a reason for hiding this comment

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

But it's technically not true, is it?

I was planning to open a PR that removes it, set a reminder and then get it approved/merged when the time came :)

I'd just remove it and keep the warning forever.

That's fine. I'll just remove it.

);
blockType.attributes = {};
}

const settings = applyFilters(
'blocks.registerBlockType',
blockType,
Expand Down
Loading