diff --git a/modules/user/user.module b/modules/user/user.module index 3287c9e26d26c8b2df231317f29c229473764a81..277c5fc5af8da61c37f649058888002064c1f6fa 100644 --- a/modules/user/user.module +++ b/modules/user/user.module @@ -2832,19 +2832,23 @@ function user_permission_get_modules() { * * This function may be used to grant and revoke multiple permissions at once. * For example, when a form exposes checkboxes to configure permissions for a - * role, the submitted values may be directly passed on in a form submit - * handler. + * role, the form submit handler may directly pass the submitted values for the + * checkboxes form element to this function. * * @param $rid * The ID of a user role to alter. * @param $permissions - * An array of permissions, where the key holds the permission name and the - * value is an integer or boolean that determines whether to grant or revoke - * the permission: + * An associative array, where the key holds the permission name and the value + * determines whether to grant or revoke that permission. Any value that + * evaluates to TRUE will cause the permission to be granted. Any value that + * evaluates to FALSE will cause the permission to be revoked. * @code * array( - * 'administer nodes' => 0, - * 'access user profiles' => 1, + * 'administer nodes' => 0, // Revoke 'administer nodes' + * 'administer blocks' => FALSE, // Revoke 'administer blocks' + * 'access user profiles' => 1, // Grant 'access user profiles' + * 'access content' => TRUE, // Grant 'access content' + * 'access comments' => 'access comments', // Grant 'access comments' * ) * @endcode * Existing permissions are not changed, unless specified in $permissions.