Changeset 10885

Timestamp:

06/15/2016 11:33:22 PM (8 years ago)

Author:

dcavins

Message:

Groups: Add usage examples to bp_get_user_groups().

Add common usage examples to the long description of the new function
bp_get_user_groups().

See #6327.

File:

• trunk/src/bp-groups/bp-groups-functions.php (modified) (1 diff)

trunk/src/bp-groups/bp-groups-functions.php

@@ -794 +794 @@
  * Get a list of groups of which the specified user is a member.
  *
+ * Get a list of the groups to which this member belongs,
+ * filtered by group membership status and role.
+ * Usage examples: Used with no arguments specified,
+ *
+ *    bp_get_user_groups( bp_loggedin_user_id() );
+ *
+ * returns an array of the groups in which the logged-in user
+ * is an unpromoted member. To fetch an array of all groups that
+ * the current user belongs to, in any membership role,
+ * member, moderator or administrator, use
+ *
+ *    bp_get_user_groups( $user_id, array(
+ *        'is_admin' => null,
+ *        'is_mod' => null,
+ *    ) );
+ *
  * @since 2.6.0
  *