Changeset 7948 for trunk/bp-groups/bp-groups-functions.php

Timestamp:

02/21/2014 01:50:30 PM (11 years ago)

Author:

boonebgorges

Message:

Introduce support for a 'type' sorting parameter in BP_Group_Member_Query

The 'type' parameter supports any of the arguments ('newest', 'active', etc)
supported by the parent class BP_User_Query. In addition, it's possible to
sort by type 'last_joined' and 'first_joined'.

This changeset also introduces the 'type' parameter through the
bp_group_has_members() function stack.

See #921

Props imath, boonebgorges

File:

• trunk/bp-groups/bp-groups-functions.php (modified) (3 diffs)

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

@@ -385 +385 @@
  *           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'.
  * }
- * @param int $group_id
- * @param int $limit Maximum members to return
- * @param int $page The page of results to return (requires $limit)
- * @param bool $exclude_admins_mods Whether to exclude admins and mods
- * @param bool $exclude_banned Whether to exclude banned users
- * @param array|string $exclude Array or comma-sep list of users to exclude
- * @return array Multi-d array of 'members' list and 'count'
+ * @return array Multi-d array of 'members' list and 'count'.
  */
 function groups_get_group_members( $args = array() ) {
@@ -423 +421 @@
         'group_role'          => array(),
         'search_terms'        => false,
+        'type'                => 'last_joined',
     ) );
 
@@ -456 +455 @@
             'exclude'        => $r['exclude'],
             'search_terms'   => $r['search_terms'],
-            'type'           => 'last_modified',
+            'type'           => $r['type'],
         ) );