Changeset 10012 for trunk/src/bp-core/bp-core-caps.php

Timestamp:

07/12/2015 12:49:36 AM (11 years ago)

Author:

tw2113

Message:

First pass at BP-Core docs cleanup.

See #6398.

File:

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

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

@@ -12 +12 @@
 
 /**
- * Return an array of roles from the currently loaded blog
+ * Return an array of roles from the currently loaded blog.
  *
  * WordPress roles are dynamically flipped when calls to switch_to_blog() and
@@ -133 +133 @@
  *       args.
  *
- * @param array $caps See {@link WP_User::has_cap()}.
- * @param string $cap See {@link WP_User::has_cap()}.
- * @param int $user_id See {@link WP_User::has_cap()}.
- * @param mixed $args See {@link WP_User::has_cap()}.
+ * @param array  $caps    See {@link WP_User::has_cap()}.
+ * @param string $cap     See {@link WP_User::has_cap()}.
+ * @param int    $user_id See {@link WP_User::has_cap()}.
+ * @param mixed  $args    See {@link WP_User::has_cap()}.
+ *
  * @return array Actual capabilities for meta capability. See {@link WP_User::has_cap()}.
  */
@@ -186 +187 @@
  *
  * @param string $role The role for which you're loading caps.
+ *
  * @return array Capabilities for $role.
  */
@@ -273 +275 @@
  *     @type mixed $a,...   Optional. Extra arguments applicable to the capability check.
  * }
+ *
  * @return bool True if the user has the cap for the given parameters.
  */
@@ -335 +338 @@
  * @see WP_User::has_cap()
  *
- * @param array $allcaps The caps that WP associates with the given role.
- * @param array $caps The caps being tested for in WP_User::has_cap().
- * @param array $args Miscellaneous arguments passed to the user_has_cap filter.
+ * @param array  $caps    The caps that WP associates with the given role.
+ * @param string $cap     The caps being tested for in WP_User::has_cap().
+ * @param int    $user_id ID of the user being checked against.
+ * @param array  $args    Miscellaneous arguments passed to the user_has_cap filter.
+ *
  * @return array $allcaps The user's cap list, with 'bp_moderate' appended, if relevant.
  */