Changeset 48574 for trunk/src/wp-includes/class-wp-role.php

Timestamp:

07/23/2020 12:50:57 AM (6 years ago)

Author:

johnbillion

Message:

Docs: Various formatting improvements to inline docblocks.

See #49572

File:

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

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

@@ -26 +26 @@
          *
          * @since 2.0.0
-         * @var array
+         * @var bool[] Array of key/value pairs where keys represent a capability name and boolean values
+         *             represent whether the role has that capability.
          */
         public $capabilities;
@@ -33 +34 @@
          * Constructor - Set up object properties.
          *
-         * The list of capabilities, must have the key as the name of the capability
+         * The list of capabilities must have the key as the name of the capability
          * and the value a boolean of whether it is granted to the role.
          *
@@ -39 +40 @@
          *
          * @param string $role         Role name.
-         * @param bool[] $capabilities List of capabilities keyed by the capability name,
-         *                             e.g. array( 'edit_posts' => true, 'delete_posts' => false ).
+         * @param bool[] $capabilities Array of key/value pairs where keys represent a capability name and boolean values
+         *                             represent whether the role has that capability.
          */
         public function __construct( $role, $capabilities ) {
@@ -52 +53 @@
          * @since 2.0.0
          *
-         * @param string $cap Capability name.
-         * @param bool $grant Whether role has capability privilege.
+         * @param string $cap   Capability name.
+         * @param bool   $grant Whether role has capability privilege.
          */
         public function add_cap( $cap, $grant = true ) {
@@ -62 +63 @@
         /**
          * Removes a capability from a role.
-         *
-         * This is a container for WP_Roles::remove_cap() to remove the
-         * capability from the role. That is to say, that WP_Roles::remove_cap()
-         * implements the functionality, but it also makes sense to use this class,
-         * because you don't need to enter the role name.
          *
          * @since 2.0.0
@@ -80 +76 @@
          * Determines whether the role has the given capability.
          *
-         * 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
          *
          * @param string $cap Capability name.
-         * @return bool True if the role has the given capability. False otherwise.
+         * @return bool Whether the role has the given capability.
          */
         public function has_cap( $cap ) {
@@ -96 +87 @@
                  * @since 2.0.0
                  *
-                 * @param bool[] $capabilities Associative array of capabilities for the role.
+                 * @param bool[] $capabilities Array of key/value pairs where keys represent a capability name and boolean values
+                 *                             represent whether the role has that capability.
                  * @param string $cap          Capability name.
                  * @param string $name         Role name.