3 views 
Deprecated Deprecated
This function has been deprecated. Use wp_update_user() instead.
Summery Summery
Update the status of a user in the database.
Syntax Syntax
Description Description
Previously used in core to mark a user as spam or "ham" (not spam) in Multisite.
Parameters Parameters
- $id
-
(Required) The user ID.
- $pref
-
(Required) The column in the wp_users table to update the user's status in (presumably user_status, spam, or deleted).
- $value
-
(Required) The new status for the user.
- $deprecated
-
(Optional) Deprecated as of 3.0.2 and should not be used.
Default value: null
Return Return
(int) The initially passed $value.
Source Source
File: wp-includes/ms-deprecated.php
function update_user_status( $id, $pref, $value, $deprecated = null ) {
global $wpdb;
_deprecated_function( __FUNCTION__, '5.3.0', 'wp_update_user()' );
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 ( 'spam' === $pref ) {
if ( $value == 1 ) {
/** This filter is documented in wp-includes/user.php */
do_action( 'make_spam_user', $id );
} else {
/** This filter is documented in wp-includes/user.php */
do_action( 'make_ham_user', $id );
}
}
return $value;
}
Advertisement
Changelog Changelog
| Version | Description |
|---|---|
| 5.3.0 | Use wp_update_user() |
| 3.0.0 | Introduced. |
