wp_maybe_update_user_counts( int|null $network_id = null ): bool
- Since
- 6.0.0
- Source
wp-includes/user.php:1406
Compatibility
- WordPress
- since 6.0.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
$network_idint|nulloptional- ID of the network. Defaults to the current network.Default:
null
Return value
bool- Whether the update was successful.
Performance profile
How much work a call to wp_maybe_update_user_counts() 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
- 15–32
- Plugin surface
- 1 hook
- Called by
- 0
Reads stored settings via update_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 33.
Third-party callbacks on 'enable_live_network_counts' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()called directly - optionnetwork option
update_network_option()one call below wp_maybe_update_user_counts()
Further down the call graph this can also reach serialize, cache, 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_maybe_update_user_counts() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!apply_filters() | 15–17 | is_multisite(), wp_is_large_user_count(), apply_filters() |
apply_filters() | 18–20 | is_multisite(), wp_is_large_user_count(), apply_filters(), wp_update_user_counts() |
!is_multisite() && $network_id !== null && !apply_filters() | 29 | is_multisite(), __(), sprintf(), _doing_it_wrong(), wp_is_large_user_count(), apply_filters() |
!is_multisite() && $network_id !== null && apply_filters() | 32 | is_multisite(), __(), sprintf(), _doing_it_wrong(), wp_is_large_user_count(), apply_filters(), wp_update_user_counts() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 33 instructions, 15–32 executed per call, 3 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 · 1
One hook fires while wp_maybe_update_user_counts() runs, in this order:
- apply_filters( enable_live_network_counts )filterline 1421 (+15 into the body)
Filters whether to update network site or user counts when a new site is created.
Uses · 6
- is_multisite()Determines whether Multisite is enabled.
- _doing_it_wrong()Marks something as being incorrectly called.
- __()Retrieves the translation of $text.
- 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.
- wp_update_user_counts()Updates the total count of users on the site.
Source code
function wp_maybe_update_user_counts( $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' ); } $is_small_network = ! wp_is_large_user_count( $network_id ); /** This filter is documented in wp-includes/ms-functions.php */ if ( ! apply_filters( 'enable_live_network_counts', $is_small_network, 'users' ) ) { return false; } return wp_update_user_counts( $network_id );}Changelog
Introduced in 6.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/user.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.