Fix post editor's API for pinning plugin items#34155
Merged
Conversation
|
Size Change: +14 B (0%) Total Size: 1.03 MB
ℹ️ View Unchanged
|
Member
|
I think those methods exist only for backward compatibility as they were extracted to |
gziolo
reviewed
Aug 19, 2021
| }; | ||
| export function* togglePinnedPluginItem( pluginName ) { | ||
| const isPinned = yield controls.select( | ||
| interfaceStore.name, |
Member
There was a problem hiding this comment.
Unrelated comment: did we miss controls when introducing the way to use store objects as a reference to select and dispatch calls?
Contributor
Author
There was a problem hiding this comment.
I haven't seen any that use a string literal, so I feel like this was covered. Just checked and the linting also works 👍
I did wonder whether interface's scope could also be using the store name.
Member
gziolo
approved these changes
Aug 19, 2021
Member
gziolo
left a comment
There was a problem hiding this comment.
I haven't tested but the proposed changes make sense 👍🏻
Contributor
Author
|
Thanks! |
7 tasks
Member
jorgefilipecosta
left a comment
There was a problem hiding this comment.
I think those methods exist only for backward compatibility as they were extracted to @wordpress/interface from @wordpress/edit-post. @jorgefilipecosta, do you remember how it should work?
Yes, these methods exist just for backward compatibility, all the logic is on the interface package. During the refactor we probably made a mistake, thank you for fixing this @talldan!
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
Something I noticed in passing, the
isPluginItemPinnedselector andtogglePinnedPluginItemactions in the post editor are broken. The selector has the wrong params, and the action has no matching reducer so doesn't do anything.These APIs not used internally by any code, so they're really just kept as public APIs. It could also be an option to just delete them, though if a plugin is using them (https://www.wpdirectory.net/search/01FDE8F27RZMBXZWB15C75Q5JB) that would cause an error to be triggered.
How has this been tested?
wp.data.select( 'core/edit-post' ).isPluginItemPinned( 'myAwesomePlugin' );, it should return the defaulttruevalue first timewp.data.dispatch( 'core/edit-post' ).togglePinnedPluginItem( 'myAwesomePlugin' );to toggle it off.wp.data.select( 'core/edit-post' ).isPluginItemPinned( 'myAwesomePlugin' );, it should returnfalseTypes of changes
Bug fix (non-breaking change which fixes an issue)
Checklist:
*.native.jsfiles for terms that need renaming or removal).