Changeset 9152 for trunk/src/bp-groups/bp-groups-functions.php

Timestamp:

11/17/2014 08:22:32 PM (10 years ago)

Author:

boonebgorges

Message:

Add docblock for groups_get_invites_for_group().

Props dcavins.
Fixes #6023.

File:

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

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

@@ -1048 +1048 @@
 }
 
+/**
+ * Get IDs of users with outstanding invites to a given group from a specified user.
+ *
+ * @param int $user_id ID of the inviting user.
+ * @param int $group_id ID of the group.
+ * @return array IDs of users who have been invited to the group by the
+ *         user but have not yet accepted.
+ */
 function groups_get_invites_for_group( $user_id, $group_id ) {
     return BP_Groups_Group::get_invites( $user_id, $group_id );