Changeset 13103 for trunk/src/bp-groups/classes/class-bp-groups-group.php

Timestamp:

09/09/2021 02:01:40 PM (3 years ago)

Author:

espellcaste

Message:

Improving the group member count routine and the function helper.

The group member count routine was updated to avoid direct, uncached, SQL query and unnecessary cache refresh when a group's Members page was viewed.

is now being used to get the group member count which takes into account users' existence in the site,

the query is now cached and filterable.

was also updated to get the current group from if available.

Props imath
Fixes #7614 and see #6749

File:

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

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

@@ -1724 +1724 @@
      *
      * @since 1.6.0
-     *
-     * @return int Group count.
-     */
-    public static function get_total_group_count() {
+     * @since 10.0.0 Added the `$skip_cache` parameter.
+     *
+     * @global BuddyPress $bp   The one true BuddyPress instance.
+     * @global wpdb       $wpdb WordPress database object.
+     *
+     * @param bool $skip_cache Optional. Skip getting count from cache.
+     *                         Defaults to false.
+     * @return int
+     */
+    public static function get_total_group_count( $skip_cache = false ) {
         global $wpdb;
 
-        $hidden_sql = '';
-        if ( !bp_current_user_can( 'bp_moderate' ) )
-            $hidden_sql = "WHERE status != 'hidden'";
-
-        $bp = buddypress();
-
-        return $wpdb->get_var( "SELECT COUNT(id) FROM {$bp->groups->table_name} {$hidden_sql}" );
+        $cache_key = 'bp_total_group_count';
+        $count     = wp_cache_get( $cache_key, 'bp' );
+
+        if ( false === $count || true === $skip_cache ) {
+            $hidden_sql = '';
+            if ( ! bp_current_user_can( 'bp_moderate' ) ) {
+                $hidden_sql = "WHERE status != 'hidden'";
+            }
+
+            $bp    = buddypress();
+            $count = $wpdb->get_var( "SELECT COUNT(id) FROM {$bp->groups->table_name} {$hidden_sql}" );
+
+            wp_cache_set( $cache_key, (int) $count, 'bp' );
+        }
+
+        /**
+         * Filters the total group count.
+         *
+         * @since 10.0.0
+         *
+         * @param int $count Total group count.
+         */
+        return (int) apply_filters( 'bp_groups_total_group_count', (int) $count );
     }
 
@@ -1743 +1765 @@
      *
      * @since 1.6.0
-     *
-     * @param int $group_id Group ID.
+     * @since 10.0.0 Updated to use the `groups_get_group_members`.
+     *
+     * @param int  $group_id   Group ID.
+     * @param bool $skip_cache Optional. Skip getting count from cache. Defaults to false.
      * @return int Count of confirmed members for the group.
      */
-    public static function get_total_member_count( $group_id ) {
-        global $wpdb;
-
-        $bp = buddypress();
-
-        return $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(id) FROM {$bp->groups->table_name_members} WHERE group_id = %d AND is_confirmed = 1 AND is_banned = 0", $group_id ) );
+    public static function get_total_member_count( $group_id, $skip_cache = false ) {
+        $cache_key = 'total_member_count';
+        $count     = groups_get_groupmeta( $group_id, $cache_key );
+
+        if ( false === $count || true === $skip_cache ) {
+            $members = groups_get_group_members(
+                array(
+                    'group_id'            => $group_id,
+                    'exclude_banned'      => true,
+                    'exclude_admins_mods' => false,
+                    'type'                => 'active',
+                )
+            );
+
+            $count = $members['count'] ? $members['count'] : 0;
+
+            groups_update_groupmeta( $group_id, $cache_key, (int) $count );
+        }
+
+        /**
+         * Filters the total member count for a group.
+         *
+         * @since 10.0.0
+         *
+         * @param int $count    Total member count for group.
+         * @param int $group_id The ID of the group.
+         */
+        return (int) apply_filters( 'bp_groups_total_member_count', (int) $count, (int) $group_id );
     }