From 5effdb54455a2eddfbc93c427e31e62328fbb4ab Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Mon, 14 Dec 2015 20:04:39 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@35935 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-role.php | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/wp-includes/class-wp-role.php b/src/wp-includes/class-wp-role.php index 59903e371f..335d20da9d 100644 --- a/src/wp-includes/class-wp-role.php +++ b/src/wp-includes/class-wp-role.php @@ -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