Editor: Unify the names of the sidebars between edit post and edit site. #60856
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
youknowriad
added
General Interface
youknowriad
requested review from
ajitbohra,
ryanwelcher,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
|
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. |
|
There's a potential for a small breaking change here and it seems there's no way to avoid it entirely. |
youknowriad
added
the
Needs Dev Note
|
@youknowriad I think for this one we will have to worry about backward compatibility shimms sadly... I'm aware of a few instances just myself where I've used these names to add buttons in blocks to open the sidebar panel.... |
|
I see 119 usages in the plugin directory: https://wpdirectory.net/search/01HVRHSSHKGCZE0JXV2RPJXCQC |
|
Size Change: +106 B (0%) Total Size: 1.75 MB
ℹ️ View Unchanged
|
|
So what do you suggest @fabiankaegy use the names from the post editor? |
|
@youknowriad what if we use the approach you outlined but add remapping for the old name? At least for a little while. The main issue here is that plugins need to support multiple WP versions at the same time. So we can only adopt the new name if using it on old instances doesn't break functionality If using the old name here gets remapped to the new name with a deprecated warning I think that would be the safer route |
|
I thought about remapping but it doesn't work, because we can remap "actions" but we can't remap the return value of the selectors. I think the least disruptive approach is to use the edit post names and a dev note for folks using the edit-site names. |
|
Any thoughts on the latest approach? |
fabiankaegy
approved these changes
Apr 18, 2024
There was a problem hiding this comment.
Hmmm yeah that is too bad.
Besides that I sadly don't have any other ideas how this could be solved.
I don't really like having to still use the edit-post namespace because we want to reinforce for new things that the shared editor namespace is the correct approach.
But I don't see how we can make that change without some kind of backwards compatibility handling. So this approach seems less disruptive 👍
|
Actually, to make this even more breakage free, I added mapping for actions and some selectors (the ones that can be remapped) I looked at all the usage of edit-site/template and edit-site/block-inspector in wpdirectory and the changes here should cover all of them. (Only three plugins are using these: woo, jetpack and woo blocks). The remaining one is bundling Gutenberg code. |
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.
Related #52632
What?
This PR unifies the name of the sidebars between the post and site editors. This allows us to share the same keyboard shortcut and will allow us to merge the components entirely lateR.
Testing Instructions
1- You can test the keyboard shortcut to open/close the sidebar:
cmd + shift + ,