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

Timestamp:

06/21/2017 10:37:23 PM (9 years ago)

Author:

r-a-y

Message:

Groups: Add fine-grained querying of invite sent status in groups_get_invites_for_group().

This commit introduces a new $sent parameter to groups_get_invites_for_group()
and BP_Groups_Group::get_invites(). With this parameter, developers can
now query group invites by sent status or not.

See #7397.

File:

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

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

@@ -1626 +1626 @@
  *
  * @since 1.0.0
- *
- * @param int $user_id  ID of the inviting user.
- * @param int $group_id ID of the group.
- * @return array $value 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 );
+ * @since 2.9.0 Added $sent as a parameter.
+ *
+ * @param  int      $user_id  ID of the inviting user.
+ * @param  int      $group_id ID of the group.
+ * @param  int|null $sent     Query for a specific invite sent status. If 0, this will query for users
+ *                            that haven't had an invite sent to them yet. If 1, this will query for
+ *                            users that have had an invite sent to them. If null, no invite status will
+ *                            queried. Default: null.
+ * @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, $sent = null ) {
+        return BP_Groups_Group::get_invites( $user_id, $group_id, $sent );
 }