wp_is_large_network( string $using = 'sites', int|null $network_id = null ): bool
- Since
- 3.3.0, 4.8.0
- Source
wp-includes/ms-functions.php:2650
Description
The default criteria for a large network is either more than 10,000 users or more than 10,000 sites.
Plugins can alter this criteria using the 'wp_is_large_network' filter.
Compatibility
- WordPress
- since 4.8.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$usingstringoptional- 'sites' or 'users'. Default is 'sites'.Default:
'sites' $network_idint|nulloptional- ID of the network. Default is the current network.Default:
null
Return value
bool- True if the network meets the criteria for large. False otherwise.
Performance profile
How much work a call to wp_is_large_network() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Moderate
- Scaling
- Constant
- Instructions
- 20–26
- Plugin surface
- 1 hook
- Called by
- 7
Reads stored settings via get_network_option(), cached per request but not free on a cold cache.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 39.
Third-party callbacks on 'wp_is_large_network' run inside this call, and their cost is not bounded by anything here.
7 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly - optionnetwork option
get_network_option()one call below wp_is_large_network()
Further down the call graph this can also reach cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_is_large_network() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$using !== "users" | 20 | get_blog_count(), apply_filters() |
$using === "users" | 23 | get_user_count(), wp_is_large_user_count(), apply_filters() |
$using !== "users" | 23 | get_current_network_id(), get_blog_count(), apply_filters() |
$using === "users" | 26 | get_current_network_id(), get_user_count(), wp_is_large_user_count(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 39 instructions, 20–26 executed per call, 2 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 2
2 hooks fire while wp_is_large_network() runs, in this order:
- apply_filters( wp_is_large_network )filterline 2672 (+22 into the body)
Filters whether the network is considered large.
- apply_filters( wp_is_large_network )filterline 2678 (+28 into the body)
Filters whether the network is considered large.
Uses · 5
- get_current_network_id()Retrieves the current network ID.
- get_user_count()Returns the number of active users in your installation.
- wp_is_large_user_count()Determines whether the site has a large number of users.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- get_blog_count()Gets the number of active sites on the installation.
Used by · 7
- WP_MS_Sites_List_Table::prepare_items()Prepares the list of sites for display.
- WP_MS_Users_List_Table::prepare_items()
- WP_User_Query::prepare_query()Prepares the query variables.
- wp_ajax_autocomplete_user()Handles user autocomplete via AJAX.
- wp_get_sites()Return an array of sites for a network or networks.
- wp_maybe_update_network_site_counts()Updates the count of sites for the current network.
- wp_maybe_update_network_user_counts()Updates the network-wide users count.
Source code
function wp_is_large_network( $using = 'sites', $network_id = null ) { $network_id = (int) $network_id; if ( ! $network_id ) { $network_id = get_current_network_id(); } if ( 'users' === $using ) { $count = get_user_count( $network_id ); $is_large_network = wp_is_large_user_count( $network_id ); /** * Filters whether the network is considered large. * * @since 3.3.0 * @since 4.8.0 The `$network_id` parameter has been added. * * @param bool $is_large_network Whether the network has more than 10000 users or sites. * @param string $component The component to count. Accepts 'users', or 'sites'. * @param int $count The count of items for the component. * @param int $network_id The ID of the network being checked. */ return apply_filters( 'wp_is_large_network', $is_large_network, 'users', $count, $network_id ); } $count = get_blog_count( $network_id ); /** This filter is documented in wp-includes/ms-functions.php */ return apply_filters( 'wp_is_large_network', $count > 10000, 'sites', $count, $network_id );}Changelog
Introduced in 3.3.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$network_id parameter has been added.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/ms-functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.