Changeset 7447

Timestamp:

09/07/2026 02:04:11 AM (2 weeks ago)

Author:

johnjamesjacoby

Message:

Users: distinguish forum and installation counts.

Add a cached aggregate count of current-site forum-role holders for dashboard and front-end statistics. Count each user once across forum roles and duplicate capabilities records, and invalidate cached counts when users or their capabilities change. Include the site, role list, and cache generation in each cache key.

Use WordPress's cached installation count and large-user threshold for installation-wide helpers, preserving the existing bbPress and multisite filters.

Add regression coverage for membership changes, cache reuse and invalidation, role filters, installation thresholds, and multisite isolation.

In trunk, for 2.7.

Props itzmekhokan.
Fixes #3457.
From ​https://github.com/bbpress/bbPress/pull/16.

Location:

trunk

Files:

• CHANGELOG.md (modified) (1 diff)
• src/includes/common/functions.php (modified) (1 diff)
• src/includes/core/abstraction.php (modified) (3 diffs)
• src/includes/core/actions.php (modified) (1 diff)
• src/includes/core/cache.php (modified) (1 diff)
• tests/phpunit/testcases/users/functions/counts.php (modified) (1 diff)
• tests/phpunit/testcases/users/functions/statistics.php (added)

trunk/CHANGELOG.md

@@ -48 +48 @@
 ### Fixed
 
+- Cache a distinct count of current-site forum-role holders for forum statistics,
+  invalidating it when users or their capabilities change. Use the WordPress
+  installation count for large-installation upgrade decisions.
 - Show an ellipsis for long topic metadata in the default templates, revealing
   the full text when a link receives focus.

trunk/src/includes/common/functions.php

@@ -445 +445 @@
         $trash   = bbp_get_trash_status_id();
 
-        // Users
+        // Users with a forum role on the current site
         $user_count = ! empty( $r['count_users'] )
-                ? bbp_get_total_users()
+                ? bbp_get_total_forum_users()
                 : 0;
 

trunk/src/includes/core/abstraction.php

@@ -345 +345 @@
 function bbp_is_large_install() {
 
-        // Multisite has a function specifically for this
+        // Preserve the network filter on multisite and use the core user threshold
         $retval = function_exists( 'wp_is_large_network' )
                 ? wp_is_large_network( 'users' )
-                : ( bbp_get_total_users() > 10000 );
+                : wp_is_large_user_count();
 
         // Filter & return
@@ -355 +355 @@
 
 /**
- * Get the total number of users on the forums.
+ * Get the cached installation-wide user count maintained by WordPress.
+ *
+ * On multisite, this is the network count, not the current site forum-role count.
  *
  * @since 2.0.0 bbPress (r2769)
@@ -362 +364 @@
  */
 function bbp_get_total_users() {
+        $count = get_user_count();
+
+        // Filter & return
+        return (int) apply_filters( 'bbp_get_total_users', (int) $count );
+}
+
+/**
+ * Count users with a forum role on the current site.
+ *
+ * Includes blocked users and counts users with multiple forum roles only once.
+ * Role membership is matched in stored capabilities, as in count_users().
+ *
+ * @since 2.7.0
+ *
+ * @return int Total number of forum-role holders.
+ */
+function bbp_get_total_forum_users() {
         $bbp_db = bbp_db();
-        $count  = $bbp_db->get_var( "SELECT COUNT(ID) as c FROM {$bbp_db->users} WHERE user_status = '0'" );
-
-        // Filter & return
-        return (int) apply_filters( 'bbp_get_total_users', (int) $count );
+        $roles  = array_keys( bbp_get_dynamic_roles() );
+        $count  = 0;
+
+        if ( ! empty( $roles ) ) {
+                sort( $roles );
+
+                // Use the global users group so changes on other sites invalidate counts
+                $last_changed = wp_cache_get( 'bbp_forum_users_last_changed', 'users' );
+                if ( false === $last_changed ) {
+                        wp_cache_add( 'bbp_forum_users_last_changed', microtime(), 'users' );
+                        $last_changed = wp_cache_get( 'bbp_forum_users_last_changed', 'users' );
+                }
+
+                $meta_key  = $bbp_db->get_blog_prefix() . 'capabilities';
+                $cache_key = 'bbp_forum_users:' . md5( serialize( array( $bbp_db->users, $bbp_db->usermeta, $meta_key, $roles, $last_changed ) ) );
+                $count     = wp_cache_get( $cache_key, 'users' );
+
+                if ( false === $count ) {
+                        $clauses = array();
+                        foreach ( $roles as $role ) {
+                                $clauses[] = $bbp_db->prepare( 'meta_value LIKE %s', '%' . $bbp_db->esc_like( '"' . $role . '"' ) . '%' );
+                        }
+
+                        // Match any forum role without returning users or pagination totals
+                        $role_sql = implode( ' OR ', $clauses );
+                        $key_sql  = $bbp_db->prepare( 'meta_key = %s', $meta_key );
+                        $count    = $bbp_db->get_var( "SELECT COUNT(DISTINCT user_id) FROM {$bbp_db->usermeta} INNER JOIN {$bbp_db->users} ON user_id = ID WHERE {$key_sql} AND ({$role_sql})" );
+
+                        // Do not cache failed queries; expire superseded cache generations
+                        if ( null !== $count ) {
+                                $count = (int) $count;
+                                wp_cache_set( $cache_key, $count, 'users', HOUR_IN_SECONDS );
+                        }
+                }
+        }
+
+        // Filter the result after caching so request-specific overrides stay local
+        return (int) apply_filters( 'bbp_get_total_forum_users', (int) $count );
 }
 

trunk/src/includes/core/actions.php

@@ -417 +417 @@
 add_action( 'clean_post_cache', 'bbp_clean_post_cache', 10, 2 );
 
+// Invalidate forum-user counts after users or their capabilities change
+add_action( 'clean_user_cache',  'bbp_clean_user_count_cache' );
+add_action( 'added_user_meta',   'bbp_clean_user_count_cache_on_meta_change', 10, 3 );
+add_action( 'updated_user_meta', 'bbp_clean_user_count_cache_on_meta_change', 10, 3 );
+add_action( 'deleted_user_meta', 'bbp_clean_user_count_cache_on_meta_change', 10, 3 );
+
 // User Registration
 add_action( 'added_existing_user', 'bbp_user_add_role_on_register', 10, 1 );

trunk/src/includes/core/cache.php

@@ -170 +170 @@
         }
 }
+
+/**
+ * Invalidate cached forum-user counts across sites sharing the users table.
+ *
+ * @since 2.7.0
+ */
+function bbp_clean_user_count_cache() {
+        wp_cache_set( 'bbp_forum_users_last_changed', microtime(), 'users' );
+}
+
+/**
+ * Invalidate forum-user counts after capabilities metadata changes.
+ *
+ * @since 2.7.0
+ *
+ * @param int|array $meta_id  Metadata ID or IDs.
+ * @param int       $user_id User ID.
+ * @param string    $key     Metadata key.
+ */
+function bbp_clean_user_count_cache_on_meta_change( $meta_id, $user_id, $key ) {
+        if ( preg_match( '/(^|_)capabilities$/', $key ) ) {
+                bbp_clean_user_count_cache();
+        }
+}

trunk/tests/phpunit/testcases/users/functions/counts.php

@@ -158 +158 @@
                 $this->factory->user->create_many( 3 );
 
+                wp_update_user_counts();
                 $users = (int) bbp_get_total_users();
 
-                // 15 + 1, the + 1 is the default admin user
+                // Three users plus the default administrator
                 $this->assertSame( 4, $users );
         }