Stabilize the useResourcePermissions hook #43268
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
adamziel
added
the
Developer Experience
gziolo
added
Needs Dev Note
|
Thank you for going back to make this API stable. I support the idea! Do you know why I would expect to see the JSDoc for the stable now function included in the README file of the As for the dev note, it's something that should be compiled together with other changes to the package – new API for |
|
@gziolo I just added the README and Changelog entries, good call!
Good call as well, I can see other places where this would be useful. Let's pursue the refactor separately from this PR. |
gziolo
reviewed
Aug 16, 2022
gziolo
approved these changes
Aug 16, 2022
There was a problem hiding this comment.
Excellent, looks good from my perspective after the revisions were applied.
Good call as well, I can see other places where this would be useful. Let's pursue the refactor separately from this PR
Awesome, it would be great to tackle it in parallel to confirm that the stable API is flexible enough.
gziolo
reviewed
Aug 16, 2022
|
Size Change: +657 B (0%) Total Size: 1.24 MB
ℹ️ View Unchanged
|
|
Here's the PR where I explore the refactor: #43305 |
adamziel
force-pushed
the
stabilize/experimentalUseResourcePermissions
branch
from
32b3412 to
7dddad6
Compare
adamziel
force-pushed
the
stabilize/experimentalUseResourcePermissions
branch
from
7dddad6 to
a279889
Compare
|
We have now a few more places to update |
gziolo
reviewed
Aug 19, 2022
|
In other news, this is the last task that concludes the proposal from https://make.wordpress.org/core/2022/07/04/proposal-better-rest-api-handling-in-javascript/. The only task left is compiling a dev note covering all final changes and enriching the documentation with the new APIs after WordPress 6.1 is out. Everything here is built on top of existing public APIs, so that means we eventually need to decrease the visibility of low-level APIs in the Block Editor Handbook. Awesome work @adamziel 🚀 |
…useResourcePermissions
adamziel
requested review from
draganescu,
talldan,
noisysocks and
kevin940726
as code owners
gziolo
approved these changes
Aug 19, 2022
|
Thanks, @adamziel. I agree that the hook was ready for stabilization. The one issue I would like to see resolved, and it's not entirely related to this hook, is the one I mentioned in #35527 (comment). When using this hook, even if you only check for single permission, it will still make multiple calls to the same endpoint. While a few extra API calls aren't necessarily bad, numbers will add up as we continue adoption in the core. Examplevar el = wp.element.createElement;
var __ = wp.i18n.__;
var registerPlugin = wp.plugins.registerPlugin;
var PluginDocumentSettingPanel = wp.editPost.PluginDocumentSettingPanel;
var useResourcePermissions = wp.coreData.useResourcePermissions;
function MyDocumentSettingPlugin() {
// Replace tag ID.
const { canUpdate } = useResourcePermissions( 'tags', 20 );
if ( ! canUpdate ) {
return null;
}
return el(
PluginDocumentSettingPanel,
{
className: 'my-document-setting-plugin',
title: 'Permissions',
},
__( 'User has required Permissions' )
);
}
registerPlugin( 'my-document-setting-plugin', {
render: MyDocumentSettingPlugin,
} ); |
This was referenced Aug 22, 2022
|
@Mamaduka good note! As you noticed, it is not specific to this hook - see this patch for |
|
Dev note proposed at https://make.wordpress.org/core/?p=99829&preview=1&_ppp=2b1db975ea |
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?
It's been two months since the
__experimentalUseResourcePermissionshook was introduced in PR #38785. This PR stabilizes it.CC @gziolo @Mamaduka @kevin940726