WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_update_user_counts()

wp_update_user_counts( int|null $network_id = null ): bool

In this article

Back to top

Updates the total count of users on the site.

Parameters

$network_idint|nulloptional
ID of the network. Defaults to the current network.

Default:null

Return

bool Whether the update was successful.

Source

function wp_update_user_counts( $network_id = null ) {	global $wpdb;	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'	);	}	$query = "SELECT COUNT(ID) as c FROM $wpdb->users";	if ( is_multisite() ) {	$query .= " WHERE spam = '0' AND deleted = '0'";	}	$count = $wpdb->get_var( $query );	return update_network_option( $network_id, 'user_count', $count ); }

View all references View on Trac View on GitHub

UsesDescription
update_network_option()wp-includes/option.php

Updates the value of a network option that was already added.

is_multisite()wp-includes/load.php

Determines whether Multisite is enabled.

_doing_it_wrong()wp-includes/functions.php

Marks something as being incorrectly called.

wpdb::get_var()wp-includes/class-wpdb.php

Retrieves one value from the database.

Show 2 moreShow less
Used byDescription
wp_maybe_update_user_counts()wp-includes/user.php

Updates the total count of users on the site if live user counting is enabled.

wp_update_network_user_counts()wp-includes/ms-functions.php

Updates the network-wide user count.

Changelog

VersionDescription
6.0.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.