sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Clarify some terminology around meta capabilities, primitive capabilities, and roles.

Browse Source 
See #41017


git-svn-id: https://develop.svn.wordpress.org/trunk@41366 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2017-09-10 22:50:27 +00:00
parent 0c29992e72
commit 45429a417b
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/wp-includes/class-wp-user.php
View File

@ -672,27 +672,26 @@ class WP_User {
} }
/** /**
* Whether user has capability or role name. * Whether the user has a specific capability.
* *
* While checking against particular roles in place of a capability is supported * While checking against a role in place of a capability is supported in part, this practice is discouraged as it
* in part, this practice is discouraged as it may produce unreliable results. * may produce unreliable results.
* *
* @since 2.0.0 * @since 2.0.0
* *
* @see map_meta_cap() * @see map_meta_cap()
* *
* @param string $cap Capability name. * @param string $cap Capability name.
* @param int $object_id,... Optional. ID of the specific object to check against if `$cap` is a "meta" cap. * @param int $object_id,... Optional. ID of a specific object to check against if `$cap` is a "meta" capability.
* "Meta" capabilities, e.g. 'edit_post', 'edit_user', etc., are capabilities used * Meta capabilities such as `edit_post` and `edit_user` are capabilities used by
* by map_meta_cap() to map to other "primitive" capabilities, e.g. 'edit_posts', * by the `map_meta_cap()` function to map to primitive capabilities that a user or
* 'edit_others_posts', etc. The parameter is accessed via func_get_args() and passed * role has, such as `edit_posts` and `edit_others_posts`.
* to map_meta_cap(). * @return bool Whether the user has the given capability, or, if `$object_id` is passed, whether the user has
* @return bool Whether the current user has the given capability. If `$cap` is a meta cap and `$object_id` is * the given capability for that object.
* passed, whether the current user has the given meta capability for the given object.
*/ */
public function has_cap( $cap ) { public function has_cap( $cap ) {
if ( is_numeric( $cap ) ) { if ( is_numeric( $cap ) ) {
_deprecated_argument( __FUNCTION__, '2.0.0', __('Usage of user levels by plugins and themes is deprecated. Use roles and capabilities instead.') ); _deprecated_argument( __FUNCTION__, '2.0.0', __( 'Usage of user levels is deprecated. Use capabilities instead.' ) );
$cap = $this->translate_level_to_cap( $cap ); $cap = $this->translate_level_to_cap( $cap );
} }