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

Timestamp:

06/03/2013 05:12:54 PM (12 years ago)

Author:

boonebgorges

Message:

Introduces BP_Group_Member_Query and refactors bp_group_has_members() to use it

BP_Group_Member_Query extends BP_User_Query, which has a number of notable
benefits:

• Group member queries no longer JOIN against global user tables
• Less code duplication, since general logic like 'exclude' is handled by BP_User_Query
• Future access to the additional parameters of BP_User_Query, such as 'type'

Using the new BP_Group_Member_Query, this changeset also changes the way that
group member queries filter by group roles (member, mod, admin). The new
group_role parameter in the bp_group_has_members() stack accepts an array of
group roles. The legacy argument 'exclude_admins_mods' is still accepted, and
translates to 'group_role' => array( 'member' ) when true. These group_role
enhancements will allow for future enhancements in the Groups Admin section of
the Dashboard, and other places where it might be useful to query for the
members of a group matching a specific role. See #4977.

Fixes #4482

Props trishasalas for early patches and feedback. Props johnjamesjacoby for
review.

File:

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

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

@@ -383 +383 @@
  * Fetch the members of a group
  *
- * Procedural wrapper for BP_Groups_Member::get_all_for_group().
+ * Since BuddyPress 1.8, a procedural wrapper for BP_Group_Member_Query.
+ * Previously called BP_Groups_Member::get_all_for_group().
+ *
+ * To use the legacy query, filter 'bp_use_legacy_group_member_query',
+ * returning true.
  *
  * @param int $group_id
@@ -393 +397 @@
  * @return array Multi-d array of 'members' list and 'count'
  */
-function groups_get_group_members( $group_id, $limit = false, $page = false, $exclude_admins_mods = true, $exclude_banned = true, $exclude = false ) {
-    return BP_Groups_Member::get_all_for_group( $group_id, $limit, $page, $exclude_admins_mods, $exclude_banned, $exclude );
+function groups_get_group_members( $group_id, $limit = false, $page = false, $exclude_admins_mods = true, $exclude_banned = true, $exclude = false, $group_role = false ) {
+
+    // For legacy users. Use of BP_Groups_Member::get_all_for_group()
+    // is deprecated.
+    if ( apply_filters( 'bp_use_legacy_group_member_query', false, __FUNCTION__, func_get_args() ) ) {
+        $retval = BP_Groups_Member::get_all_for_group( $group_id, $limit, $page, $exclude_admins_mods, $exclude_banned, $exclude );
+    } else {
+
+        // exclude_admins_mods is a legacy argument. Convert to group_role
+        if ( empty( $group_role ) ) {
+            $group_role = $exclude_admins_mods ? array( 'member' ) : array( 'member', 'mod', 'admin' );
+        }
+
+        // Perform the group member query (extends BP_User_Query)
+        $members = new BP_Group_Member_Query( array(
+            'group_id'       => $group_id,
+            'per_page'       => $limit,
+            'page'           => $page,
+            'group_role'     => $group_role,
+            'exclude_banned' => $exclude_banned,
+            'exclude'        => $exclude,
+            'type'           => 'last_modified',
+        ) );
+
+        // Structure the return value as expected by the template functions
+        $retval = array(
+            'members' => array_values( $members->results ),
+            'count'   => $members->total_users,
+        );
+    }
+
+    return $retval;
 }