Add note about wpnonce on permissions callback #19
Conversation
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
The example shows current_user_can() to validate permissions on a REST request. This is a common and useful permission check, however it does require the 'wp_rest' nonce to be present in the REST request or the request is treated as if the user was logged out.
rmccue reviewed Mar 1, 2018
| | ||
| Note that the permission callback also receives the Request object as the first parameter, so you can do checks based on request arguments if you need to. | ||
| | ||
| For user based permissions such as current_user_can() the app calling the REST endpoint must pass along the \_wpnonce argument that has been created with a wp_create_nonce( 'wp_rest' ) call. Failure to do so will cause the REST API to treat the request as if it was from a logged out user. |
There was a problem hiding this comment.
This should probably just link to the Authentication page, with copy like...
Note: Users are authenticated before your permission callback is called. For cookie-based authentication, this includes nonce checks; a missing nonce will treat the request as if it was from a logged out user.
| @charlestonsoftware I concur with Ryan's assessment above. If you can re-word I can review and merge. |
| #46 is similar to this, but links to the Auth page, and IMO has a clearer description. |
| Closing since #46 has been merged. |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
5 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.
The example shows current_user_can() to validate permissions on a REST request. This is a common and useful permission check, however it does require the 'wp_rest' nonce to be present in the REST request or the request is treated as if the user was logged out.