Changeset 11792

Timestamp:

01/04/2018 04:05:39 PM (7 years ago)

Author:

djpaul

Message:

Groups: add support to query for members from multiple groups.

Fixes #7573

Props r-a-y, dcavins

Location:

trunk/src/bp-groups

Files:

• bp-groups-functions.php (modified) (1 diff)
• classes/class-bp-group-member-query.php (modified) (3 diffs)

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

@@ -642 +642 @@
  *
  * @since 1.0.0
+ * @since 3.0.0 $group_id now supports multiple values. Only works if legacy query is not
+ *              in use.
  *
  * @param array $args {
  *     An array of optional arguments.
- *     @type int      $group_id     ID of the group whose members are being queried.
- *                                  Default: current group ID.
- *     @type int      $page         Page of results to be queried. Default: 1.
- *     @type int      $per_page     Number of items to return per page of results.
- *                                  Default: 20.
- *     @type int      $max          Optional. Max number of items to return.
- *     @type array    $exclude      Optional. Array of user IDs to exclude.
- *     @type bool|int $value        True (or 1) to exclude admins and mods from results.
- *                                  Default: 1.
- *     @type bool|int $value        True (or 1) to exclude banned users from results.
- *                                  Default: 1.
- *     @type array    $group_role   Optional. Array of group roles to include.
- *     @type string   $search_terms Optional. Filter results by a search string.
- *     @type string   $type         Optional. Sort the order of results. 'last_joined',
- *                                  'first_joined', or any of the $type params available
- *                                  in {@link BP_User_Query}. Default: 'last_joined'.
+ *     @type int|array|string $group_id            ID of the group to limit results to. Also accepts multiple values
+ *                                                 either as an array or as a comma-delimited string.
+ *     @type int              $page                Page of results to be queried. Default: 1.
+ *     @type int              $per_page            Number of items to return per page of results. Default: 20.
+ *     @type int              $max                 Optional. Max number of items to return.
+ *     @type array            $exclude             Optional. Array of user IDs to exclude.
+ *     @type bool|int         $exclude_admins_mods True (or 1) to exclude admins and mods from results. Default: 1.
+ *     @type bool|int         $exclude_banned      True (or 1) to exclude banned users from results. Default: 1.
+ *     @type array            $group_role          Optional. Array of group roles to include.
+ *     @type string           $search_terms        Optional. Filter results by a search string.
+ *     @type string           $type                Optional. Sort the order of results. 'last_joined', 'first_joined', or
+ *                                                 any of the $type params available in {@link BP_User_Query}. Default:
+ *                                                 'last_joined'.
  * }
  * @return false|array Multi-d array of 'members' list and 'count'.

trunk/src/bp-groups/classes/class-bp-group-member-query.php

@@ -25 +25 @@
  *
  * @since 1.8.0
+ * @since 3.0.0 $group_id now supports multiple values.
  *
  * @param array $args  {
@@ -30 +31 @@
  *     {@link BP_User_Query}, with the following additions:
  *
- *     @type int    $group_id     ID of the group to limit results to.
- *     @type array  $group_role   Array of group roles to match ('member',
- *                                'mod', 'admin', 'banned').
- *                                Default: array( 'member' ).
- *     @type bool   $is_confirmed Whether to limit to confirmed members.
- *                                Default: true.
- *     @type string $type         Sort order. Accepts any value supported by
- *                                {@link BP_User_Query}, in addition to 'last_joined'
- *                                and 'first_joined'. Default: 'last_joined'.
+ *     @type int|array|string $group_id     ID of the group to limit results to. Also accepts multiple values
+ *                                          either as an array or as a comma-delimited string.
+ *     @type array            $group_role   Array of group roles to match ('member', 'mod', 'admin', 'banned').
+ *                                          Default: array( 'member' ).
+ *     @type bool             $is_confirmed Whether to limit to confirmed members. Default: true.
+ *     @type string           $type         Sort order. Accepts any value supported by {@link BP_User_Query}, in
+ *                                          addition to 'last_joined' and 'first_joined'. Default: 'last_joined'.
  * }
  */
@@ -138 +137 @@
 
         // Group id.
-        $sql['where'][] = $wpdb->prepare( "group_id = %d", $this->query_vars['group_id'] );
+        $group_ids = wp_parse_id_list( $this->query_vars['group_id'] );
+        $group_ids = implode( ',', $group_ids );
+        $sql['where'][] = "group_id IN ({$group_ids})";
 
         // If is_confirmed.