vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-08-13 05:10:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Standardise documentation for capability-related variadic functions.

Browse Source 
See #37402


git-svn-id: https://develop.svn.wordpress.org/trunk@45419 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2019-05-25 22:26:22 +00:00
parent b64f812a59
commit 51ab0b5824
2 changed files with 76 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/wp-includes/class-wp-user.php
+14 -7
View File
@@ -712,7 +712,17 @@ class WP_User {
}
/**
* Whether the user has a specific capability.
* Returns whether the user has the specified capability.
*
* This function also accepts an ID of an object to check against if the capability is a meta capability. Meta
* capabilities such as `edit_post` and `edit_user` are capabilities used by the `map_meta_cap()` function to
* map to primitive capabilities that a user or role has, such as `edit_posts` and `edit_others_posts`.
*
* Example usage:
*
* $user->has_cap( 'edit_posts' );
* $user->has_cap( 'edit_post', $post->ID );
* $user->has_cap( 'edit_post_meta', $post->ID, $meta_key );
*
* While checking against a role in place of a capability is supported in part, this practice is discouraged as it
* may produce unreliable results.
@@ -721,12 +731,9 @@ class WP_User {
*
* @see map_meta_cap()
*
* @param string $cap Capability name.
* @param int ...$object_id Optional. ID of a specific object to check against if `$cap` is a "meta" capability.
* Meta capabilities such as `edit_post` and `edit_user` are capabilities used by
* by the `map_meta_cap()` function to map to primitive capabilities that a user or
* role has, such as `edit_posts` and `edit_others_posts`.
* @return bool Whether the user has the given capability, or, if `$object_id` is passed, whether the user has
* @param string $cap Capability name.
* @param mixed ...$args Optional further parameters, typically starting with an object ID.
* @return bool Whether the user has the given capability, or, if an object ID is passed, whether the user has
* the given capability for that object.
*/
public function has_cap( $cap ) {