wppaste
WordPress

wp_maybe_update_network_user_counts( int|null $network_id = null )

Since
3.7.0, 4.8.0
Source
wp-includes/ms-functions.php:2530
Updates the network-wide users count.

Description

If enabled through the 'enable_live_network_counts' filter, update the users count on a network when a user is created or its status is updated.

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

$network_idint|nulloptional
ID of the network. Default is the current network.Default: null

Performance profile

How much work a call to wp_maybe_update_network_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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
13–16

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 17.

Plugin surface
1 hook

Third-party callbacks on 'enable_live_network_counts' run inside this call, and their cost is not bounded by anything here.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, 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 · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_maybe_update_network_user_counts() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
!apply_filters()13wp_is_large_network(), apply_filters()
apply_filters()16wp_is_large_network(), apply_filters(), wp_update_network_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: 17 instructions, 13–16 executed per call, 1 branch. 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_network_user_counts() runs, in this order:

  1. apply_filters( enable_live_network_counts )filterline 2534 (+4 into the body)

    Filters whether to update network site or user counts when a new site is created.

Uses · 3

Source code

View on Trac View on GitHub 

function wp_maybe_update_network_user_counts( $network_id = null ) {	$is_small_network = ! wp_is_large_network( 'users', $network_id ); 	/** This filter is documented in wp-includes/ms-functions.php */	if ( ! apply_filters( 'enable_live_network_counts', $is_small_network, 'users' ) ) {		return;	} 	wp_update_network_user_counts( $network_id );}

Changelog

Introduced in 3.7.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

4.8.0
The $network_id parameter has been added.from the docblock
3.7.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 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.