Changeset 35935

Timestamp:

12/14/2015 08:04:39 PM (9 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/class-wp-role.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-role.php

@@ -82 +82 @@
 
     /**
-     * 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
@@ -93 +93 @@
      *
      * @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 ) {
@@ -106 +106 @@
          */
         $capabilities = apply_filters( 'role_has_cap', $this->capabilities, $cap, $this->name );
+
         if ( !empty( $capabilities[$cap] ) )
             return $capabilities[$cap];