update_user_status( int $id, string $pref, int $value, null $deprecated = null )
This function has been deprecated. Use wp_update_user() instead.
Update the status of a user in the database.
Description
Previously used in core to mark a user as spam or "ham" (not spam) in Multisite.
See also
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
Return
(int) The initially passed $value.
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; }
Changelog
Version | Description |
---|---|
5.3.0 | Use wp_update_user() |
3.0.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/update_user_status