update_user_status( int $id, string $pref, int $value, null $deprecated = null )

Update the status of a user in the database.


Description Description

Used in core to mark a user as spam or "ham" (not spam) in Multisite.


Parameters Parameters

$id

(int) (Required) The user ID.

$pref

(string) (Required) The column in the wp_users table to update the user's status in (presumably user_status, spam, or deleted).

$value

(int) (Required) The new status for the user.

$deprecated

(null) (Optional) Deprecated as of 3.0.2 and should not be used.

Default value: null


Top ↑

Return Return

(int) The initially passed $value.


Top ↑

Source Source

File: wp-admin/includes/ms.php

function update_user_status( $id, $pref, $value, $deprecated = null ) {
	global $wpdb;

	if ( null !== $deprecated )
		_deprecated_argument( __FUNCTION__, '3.0.2' );

	$wpdb->update( $wpdb->users, array( sanitize_key( $pref ) => $value ), array( 'ID' => $id ) );

	$user = new WP_User( $id );
	clean_user_cache( $user );

	if ( $pref == 'spam' ) {
		if ( $value == 1 ) {
			/**
			 * Fires after the user is marked as a SPAM user.
			 *
			 * @since 3.0.0
			 *
			 * @param int $id ID of the user marked as SPAM.
			 */
			do_action( 'make_spam_user', $id );
		} else {
			/**
			 * Fires after the user is marked as a HAM user. Opposite of SPAM.
			 *
			 * @since 3.0.0
			 *
			 * @param int $id ID of the user marked as HAM.
			 */
			do_action( 'make_ham_user', $id );
		}
	}

	return $value;
}

Top ↑

Changelog Changelog

Changelog
Version Description
3.0.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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