Filter hook 'pre_count_users'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into pre_count_users
add_filter('pre_count_users', 'my_custom_filter', 10, 3);

function my_custom_filter($result, $strategy, $site_id) {
    // Your custom filtering logic here
    return $result;
}

Source Code Context

<?php
1339  	 * @param null|array $result   The value to return instead. Default null to continue with the query.
1340  	 * @param string     $strategy Optional. The computational strategy to use when counting the users.
1341  	 *                             Accepts either 'time' or 'memory'. Default 'time'.
1342  	 * @param int        $site_id  The site ID to count users for.
1343  	 */
1344  	$pre = apply_filters( 'pre_count_users', null, $strategy, $site_id );
1345  
1346  	if ( null !== $pre ) {
1347  		return $pre;
1348  	}
1349  

PHP Documentation

<?php
/**
	 * Filters the user count before queries are run.
	 *
	 * Return a non-null value to cause count_users() to return early.
	 *
	 * @since 5.1.0
	 *
	 * @param null|array $result   The value to return instead. Default null to continue with the query.
	 * @param string     $strategy Optional. The computational strategy to use when counting the users.
	 *                             Accepts either 'time' or 'memory'. Default 'time'.
	 * @param int        $site_id  The site ID to count users for.
	 */