Search Block: Remove unused buttonBehavior attribute
#53467
Merged
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
t-hamano
added
[Type] Code Quality
|
Size Change: -97 B (0%) Total Size: 1.69 MB
ℹ️ View Unchanged
|
t-hamano
requested review from
ajitbohra,
ryanwelcher,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
t-hamano
removed request for
juanmaguitar,
ajitbohra,
ryanwelcher,
ndiego and
fabiankaegy
fabiankaegy
reviewed
Aug 9, 2023
There was a problem hiding this comment.
I'm not sure about this, but we are using this same pattern of attributes that never get changed within the block to allow extenders to override the behavior of a block when using them in a pattern.
For example the group block accepts an allowedBlocks attribute which can be set by a pattern to control which blocks can be inserted within.
So this change might be a breaking change for extenders that have provided a custom value in a pattern or when they wrap the block in a custom wrapper.
I don't know of any examples myself. But I just wanted to call it out here.
t-hamano
force-pushed
the
search/remove-unused-attribute
branch
from
56684c6
to
0496be4
Compare
jffng
approved these changes
Jan 4, 2024
There was a problem hiding this comment.
Thank you @t-hamano — I've tested and verified that Button Only search blocks function the same before and after this change, in addition as all other styles of the block.
I also tested by manually adding the buttonBehavior attribute to the search block. No block validation errors occurred after switching to this PR, so it doesn't appear a deprecation is needed either.
Approving because I agree we should remove the attribute since it is unused, I think it was added in an earlier iteration of this implementation before the block was refactored to use the Interactivity API.
fabiankaegy
added
the
Needs Dev Note
|
I added the Needs Dev Note label because as I stated before this technically is a backward compatibility thing. So at least in the miscellaneous dev note something should be added |
32 tasks
Dev NoteNote: It would probably be good to include it as part of a miscellaneous dev note The Search block had an attribute called With this change, this attribute will no longer be referenced even if it has been added manually. |
|
@fabiankaegy, I have written a Dev Note, could you review it to see if it is sufficient? Please feel free to update. |
t-hamano
added
has dev note
|
@t-hamano thanks for adding the dev note :) This works for me 👍 |
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.
Fixes: #53435
What?
This PR removes the
buttonBehaviorattribute from the Search block. As a result, conditional expressions that are no longer needed have also been deleted.Why?
The
buttonBehaviorattribute has a default value of "expand-searchfield", but this attribute is never updated withsetAttibutes(), so the value never changes.So removing this attribute should have no effect.
How?
block.json.Editcomponent'sgetBlockClassName()function generates two class names,wp-block-search__button-onlyandwp-block-search__button-behavior-expand, whenhasOnlyButtonis true. In other words, the two class names have the same role, so the style for either class name can be merged with the style for the other class name. I removed thewp-block-search__button-behavior-expandclass and changed it to only depend on thewp-block-search__button-onlyclass.Testing Instructions