wp_maybe_update_user_counts( int|null $network_id = null ): bool
Updates the total count of users on the site if live user counting is enabled.
Parameters
-
$network_idint|null Optional -
ID of the network. Defaults to the current network.
Default:
null
Return
bool Whether the update was successful.
Source
File: wp-includes/user.php.
View all references
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 );
}
Hooks
-
apply_filters( 'enable_live_network_counts',
bool $small_network ,string $context ) -
Filters whether to update network site or user counts when a new site is created.
Changelog
| Version | Description |
|---|---|
| 6.0.0 | Introduced. |