Docs: Clarify documentation for `WP_Role::has_cap()` to more clearing indicate that the method checks for capabilities against the role rather than the user.

Also updates syntax in the DocBlock summary and description.

Props GunGeekATX for the initial patch.
Fixes #35080.

Built from https://develop.svn.wordpress.org/trunk@35935


git-svn-id: http://core.svn.wordpress.org/trunk@35899 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-12-14 20:05:27 +00:00
parent 3bc0e35684
commit 8d884c25a3
2 changed files with 8 additions and 7 deletions

View File

@ -81,18 +81,18 @@ class WP_Role {
}
/**
* Whether role has capability.
* Determines whether the role has the given capability.
*
* The capabilities is passed through the 'role_has_cap' filter. The first
* parameter for the hook is the list of capabilities the class has
* assigned. The second parameter is the capability name to look for. The
* third and final parameter for the hook is the role name.
* The capabilities is passed through the {@see 'role_has_cap'} filter.
* The first parameter for the hook is the list of capabilities the class
* has assigned. The second parameter is the capability name to look for.
* The third and final parameter for the hook is the role name.
*
* @since 2.0.0
* @access public
*
* @param string $cap Capability name.
* @return bool True, if user has capability. False, if doesn't have capability.
* @return bool True if the role has the given capability. False otherwise.
*/
public function has_cap( $cap ) {
/**
@ -105,6 +105,7 @@ class WP_Role {
* @param string $name Role name.
*/
$capabilities = apply_filters( 'role_has_cap', $this->capabilities, $cap, $this->name );
if ( !empty( $capabilities[$cap] ) )
return $capabilities[$cap];
else

View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.5-alpha-35933';
$wp_version = '4.5-alpha-35935';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.