wp_maybe_update_network_user_counts() WordPress Function

The wp_maybe_update_network_user_counts() function is used to update the network's user count when a user is added or removed from a site. This function is only used when the network has more than one site.

wp_maybe_update_network_user_counts( int|null $network_id = null ) #

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.


Top ↑

Parameters

$network_id

(int|null)(Optional)ID of the network. Default is the current network.

Default value: null


Top ↑

Source

File: wp-includes/ms-functions.php

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 );
}


Top ↑

Changelog

Changelog
VersionDescription
4.8.0The $network_id parameter has been added.
3.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More