wp_is_large_user_count() WordPress Function
The wp_is_large_user_count() function is used to check if a large number of users exist on a WordPress site. This function is useful for site owners who want to make sure their site can handle a large number of users.
wp_is_large_user_count( int|null $network_id = null ) #
Determines whether the site has a large number of users.
Description
The default criteria for a large site is more than 10,000 users.
Parameters
- $network_id
(int|null)(Optional)ID of the network. Defaults to the current network.
Default value: null
Return
(bool) Whether the site has a large number of users.
Source
File: wp-includes/user.php
function wp_is_large_user_count( $network_id = null ) { if ( ! is_multisite() && null !== $network_id ) { _doing_it_wrong( __FUNCTION__, sprintf( /* translators: %s: $network_id */ __( 'Unable to pass %s if not using multisite.' ), '<code>$network_id</code>' ), '6.0.0' ); } $count = get_user_count( $network_id ); /** * Filters whether the site is considered large, based on its number of users. * * @since 6.0.0 * * @param bool $is_large_user_count Whether the site has a large number of users. * @param int $count The total number of users. * @param int|null $network_id ID of the network. `null` represents the current network. */ return apply_filters( 'wp_is_large_user_count', $count > 10000, $count, $network_id ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
6.0.0 | Introduced. |