Changeset 12160 for trunk/wp-includes/capabilities.php

Timestamp:

11/09/2009 10:15:50 PM (16 years ago)

Author:

westi

Message:

Better documentation on the format of the capabilities when adding a role. Fixes #11106 props simonwheatley.

File:

• trunk/wp-includes/capabilities.php (modified) (3 diffs)

trunk/wp-includes/capabilities.php

@@ -124 +124 @@
      * Updates the list of roles, if the role doesn't already exist.
      *
+     * The capabilities are defined in the following format `array( 'read' => true );`
+     * To explicitly deny a role a capability you set the value for that capability to false.
+     * 
      * @since 2.0.0
      * @access public
@@ -129 +132 @@
      * @param string $role Role name.
      * @param string $display_name Role display name.
-     * @param array $capabilities List of role capabilities.
+     * @param array $capabilities List of role capabilities in the above format.
      * @return null|WP_Role WP_Role object if role is added, null if already exists.
      */
@@ -175 +178 @@
      * @param string $role Role name.
      * @param string $cap Capability name.
-     * @param bool $grant Optional, default is true. Whether role is capable of preforming capability.
+     * @param bool $grant Optional, default is true. Whether role is capable of performing capability.
      */
     function add_cap( $role, $cap, $grant = true ) {