Ticket #6209: 6209-invite-docs.08.patch

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

@@ -856 +856 @@
 /**
  * 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.
+ * @param int $user_id ID of the invitee.
+ * @param int $limit Optional. Max number of results to return.
+ *        Default: false (no limit).
+ * @param int $page Optional. Page offset of results to return.
+ *        Default: false (no limit).
+ * @param string|array $exclude Optional. Array or comma-separated list
+ *        of group IDs to exclude from results.
+ * @return array {
+ *           @type array $groups Array of groups returned by paginated query.
+ *           @type int $total Count of groups matching query.
+ *         }
  */
 function groups_get_invites_for_user( $user_id = 0, $limit = false, $page = false, $exclude = false ) {
 
@@ -1086 +1093 @@
  * @param int $group_id ID of potential group.
  * @param string $type Optional. Use 'sent' to check for sent invites, 'all' to
  *        check for all. Default: 'sent'.
- * @return bool True if an invitation is found, otherwise false.
+ * @return int|null The ID of the invitation if found, otherwise null.
  */
 function groups_check_user_has_invite( $user_id, $group_id, $type = 'sent' ) {
         return BP_Groups_Member::check_has_invite( $user_id, $group_id, $type );
@@ -1340 +1347 @@
  *
  * @param int $user_id ID of the user.
  * @param int $group_id ID of the group.
- * @return int|null ID of the membership if found, otherwise false.
+ * @return int number of rows matched, otherwise 0. (False if arguments are empty.)
  */
 function groups_check_for_membership_request( $user_id, $group_id ) {
         return BP_Groups_Member::check_for_membership_request( $user_id, $group_id );