Block Editor: Support passing updater function to 'setAttributes' #69709
+27
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mamaduka
added
[Type] Enhancement
Mamaduka
requested review from
ellatrix,
ajitbohra and
fabiankaegy
as code owners
|
I wasn't able to find any prior discussion about this pattern, so I would love to hear feedback from @WordPress/gutenberg-core |
|
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. |
|
Size Change: +18 B (0%) Total Size: 1.85 MB
ℹ️ View Unchanged
|
|
If there are no objections, I'm going to merge this DX improvement. |
|
It would be good to revisit the existing docs as part of the effort: In particular, I was surprised that the example included covers the case that potentially could be expressed with the the updater function: const toggleSetting = () => setAttributes( { mySetting: ! mySetting } );Therefore, some best practices like in React docs would be useful as the first step. |
|
Added a new documentation section in c8fb55b. |
fabiankaegy
approved these changes
Mar 28, 2025
gziolo
reviewed
Mar 31, 2025
| @@ -135,6 +135,22 @@ const addListItem = ( newListItem ) => { | |||
|
|
|||
| Why do this? In JavaScript, arrays and objects are passed by reference, so this practice ensures changes won't affect other code that might hold references to the same data. Furthermore, the Gutenberg project follows the philosophy of the Redux library that [state should be immutable](https://redux.js.org/faq/immutable-data#what-are-the-benefits-of-immutability)—data should not be changed directly, but instead a new version of the data created containing the changes. | |||
|
|
|||
| The `setAttribute` also supports an updater function as an argument. It must be a pure function, which takes current attributes as its only argument and returns updated attributes. This method is helpful when you want to update an value based on a previous state or when working with objects and arrays. | |||
There was a problem hiding this comment.
Cool addition! It would help to add a note about WordPress version when it's going to be available. Otherwise, it might create confusion as it won't work as expected with older versions.
gziolo
approved these changes
Mar 31, 2025
Mamaduka
added
the
Needs Dev Note
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
PR updates
setAttributesmethod to support an updater function, similar to theuseStatesetter.Usage:
Why?
This should make it easier to work with complex attributes (
style,query), especially in cases where attributes need to be updated inside an effect or when callback needs to be memoized - for example, to debounce the updates.gutenberg/packages/block-library/src/query/edit/query-content.js
Lines 85 to 91 in b28716a
Testing Instructions
Testing Instructions for Keyboard
Same.