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

Timestamp:

05/18/2022 05:32:26 AM (3 years ago)

Author:

imath

Message:

Improve group members count query performance

[13103] introduced a change in 10.0.0 that can be very time consuming when a group has a lot of members.

To keep the main improvements of the referenced commit (only refreshing group members count when a user joins or leaves a group) but optimize queries performance, we are introducing a new way to count group members in the BP_Group_Member_Query.

We are also introducing a way to defer group members count when adding a batch of members to a group. Using bp_groups_defer_group_members_count() avoids to refresh the count each time a member of this batch is added. For more information about how to use this function, you can have a look at how BuddyPress is using it into src/bp-groups/bp-groups-admin.php.

Props dd32, espellcaste

See #8688 (trunk)

File:

• trunk/src/bp-groups/classes/class-bp-group-member-query.php (modified) (3 diffs)

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

@@ -51 +51 @@
 
     /**
+     * Constructor.
+     *
+     * @since 10.3.0
+     *
+     * @param string|array|null $query See {@link BP_User_Query}.
+     */
+    public function __construct( $query = null ) {
+        $qv = bp_parse_args(
+            $query,
+            array(
+                'count' => false, // True to perform a count query. False otherwise.
+            )
+        );
+
+        parent::__construct( $qv );
+    }
+
+    /**
      * Set up action hooks.
      *
@@ -63 +81 @@
         }
 
-        // Set the sort order.
-        add_action( 'bp_pre_user_query', array( $this, 'set_orderby' ) );
-
-        // Set up our populate_extras method.
-        add_action( 'bp_user_query_populate_extras', array( $this, 'populate_group_member_extras' ), 10, 2 );
+        if ( ! $this->query_vars_raw['count'] ) {
+            // Set the sort order.
+            add_action( 'bp_pre_user_query', array( $this, 'set_orderby' ) );
+
+            // Set up our populate_extras method.
+            add_action( 'bp_user_query_populate_extras', array( $this, 'populate_group_member_extras' ), 10, 2 );
+        } else {
+            $this->query_vars_raw['orderby'] = 'ID';
+        }
+    }
+
+    /**
+     * Use WP_User_Query() to pull data for the user IDs retrieved in the main query.
+     *
+     * If a `count` query is performed, the function is used to validate existing users.
+     *
+     * @since 10.3.0
+     */
+    public function do_wp_user_query() {
+        if ( ! $this->query_vars_raw['count'] ) {
+            return parent::do_wp_user_query();
+        }
+
+        /**
+         * Filters the WP User Query arguments before passing into the class.
+         *
+         * @since 10.3.0
+         *
+         * @param array         $value Array of arguments for the user query.
+         * @param BP_User_Query $this  Current BP_User_Query instance.
+         */
+        $wp_user_query = new WP_User_Query(
+            apply_filters(
+                'bp_group_members_count_query_args',
+                array(
+                    // Relevant.
+                    'fields'      => 'ID',
+                    'include'     => $this->user_ids,
+
+                    // Overrides
+                    'blog_id'     => 0,    // BP does not require blog roles.
+                    'count_total' => false // We already have a count.
+
+                ),
+                $this
+            )
+        );
+
+        // Validate existing user IDs.
+        $this->user_ids = array_map( 'intval', $wp_user_query->results );
+        $this->results  = $this->user_ids;
+
+        // Set the total existing users.
+        $this->total_users = count( $this->user_ids );
     }
 
@@ -474 +541 @@
         return wp_list_pluck( $group_user_ids, 'user_id' );
     }
+
+    /**
+     * Perform a database query to populate any extra metadata we might need.
+     *
+     * If a `count` query is performed, the function is used to validate active users.
+     *
+     * @since 10.3.0
+     */
+    public function populate_extras() {
+        if ( ! $this->query_vars_raw['count'] ) {
+            return parent::populate_extras();
+        }
+
+        // Validate active users.
+        $active_users    = array_filter( BP_Core_User::get_last_activity( $this->user_ids ) );
+        $active_user_ids = array_keys( $active_users );
+        $this->results   = array_intersect( $this->user_ids, $active_user_ids );
+
+        // Set the total active users.
+        $this->total_users = count( $this->results );
+    }
 }