wp_is_large_user_count() – Determines whether the site has a large number of users.

You appear to be a bot. Output may be restricted

Description

Determines whether the site has a large number of users.

The default criteria for a large site is more than 10,000 users.

Usage

$bool = wp_is_large_user_count( $network_id );

Parameters

$network_id
( int|null ) optional – ID of the network. Defaults to the current network.

Returns

bool Whether the site has a large number of users.

Source

File name: wordpress/wp-includes/user.php


Lines:

1 to 28 of 28
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 );
}
 

 View on GitHub View on Trac