Changeset 9640

Timestamp:

03/24/2015 06:07:07 AM (11 years ago)

Author:

tw2113

Message:

Adds hooks documentation for bp-core-caps.php.

See #5940.

File:

• trunk/src/bp-core/bp-core-caps.php (modified) (7 diffs)

trunk/src/bp-core/bp-core-caps.php

@@ -31 +31 @@
         : array();
 
-    // Apply WordPress core filter to editable roles
+    /**
+     * Filters the list of editable roles.
+     *
+     * @since BuddyPress (2.1.0)
+     *
+     * @param array $roles List of roles.
+     */
     $roles = apply_filters( 'editable_roles', $roles );
 
-    // Return the editable roles
+    /**
+     * Filters the array of roles from the currently loaded blog.
+     *
+     * @since BuddyPress (2.1.0)
+     *
+     * @param array    $roles    Available roles.
+     * @param WP_Roles $wp_roles Object of WordPress roles.
+     */
     return apply_filters( 'bp_get_current_blog_roles', $roles, $wp_roles );
 }
@@ -63 +76 @@
     }
 
+    /**
+     * Fires after the addition of capabilities to WordPress user roles.
+     *
+     * This is called on plugin activation.
+     *
+     * @since BuddyPress (1.6.0)
+     */
     do_action( 'bp_add_caps' );
 }
@@ -91 +111 @@
     }
 
+    /**
+     * Fires after the removal of capabilities from WordPress user roles.
+     *
+     * This is called on plugin deactivation.
+     *
+     * @since BuddyPress (1.6.0)
+     */
     do_action( 'bp_remove_caps' );
 }
@@ -111 +138 @@
  */
 function bp_map_meta_caps( $caps, $cap, $user_id, $args ) {
+
+    /**
+     * Filters the community caps mapping to be built in WordPress caps.
+     *
+     * @since BuddyPress (1.6.0)
+     *
+     * @param array  $caps    Returns the user's actual capabilities.
+     * @param string $cap     Capability name.
+     * @param int    $user_id The user ID.
+     * @param array  $args    Adds the context to the cap. Typically the object ID.
+     */
     return apply_filters( 'bp_map_meta_caps', $caps, $cap, $user_id, $args );
 }
@@ -128 +166 @@
     $caps = array();
 
+    /**
+     * Filters community capabilities.
+     *
+     * @since BuddyPress (1.6.0)
+     *
+     * @param array $caps Array of capabilities to add. Empty by default.
+     */
     return apply_filters( 'bp_get_community_caps', $caps );
 }
@@ -164 +209 @@
     }
 
+    /**
+     * Filters the array of capabilities based on the role that is being requested.
+     *
+     * @since BuddyPress (1.6.0)
+     *
+     * @param array  $caps Array of capabilities to return.
+     * @param string $role The role currently being loaded.
+     */
     return apply_filters( 'bp_get_caps_for_role', $caps, $role );
 }
@@ -221 +274 @@
     $retval = current_user_can_for_blog( $blog_id, $capability );
 
+    /**
+     * Filters whether or not the current user has a given capability.
+     *
+     * @since BuddyPress (1.6.0)
+     *
+     * @param bool   $retval     Whether or not the current user has the capability.
+     * @param string $capability The capability being checked for.
+     * @param int    $blog_id    Blog ID. Defaults to the BP root blog.
+     */
     return (bool) apply_filters( 'bp_current_user_can', $retval, $capability, $blog_id );
 }