Changeset 45708 for trunk/src/wp-includes/ms-deprecated.php

Timestamp:

08/01/2019 11:27:28 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Users: Deprecate update_user_status() in favor of wp_update_user().

Props spacedmonkey, SergeyBiryukov.
Fixes #45747.

File:

• trunk/src/wp-includes/ms-deprecated.php (modified) (1 diff)

trunk/src/wp-includes/ms-deprecated.php

@@ -686 +686 @@
     $wpdb->suppress_errors( $suppress );
 }
+
+/**
+ * Update the status of a user in the database.
+ *
+ * Previously used in core to mark a user as spam or "ham" (not spam) in Multisite.
+ *
+ * @since 3.0.0
+ * @deprecated 5.3.0 Use wp_update_user()
+ * @see wp_update_user()
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int    $id         The user ID.
+ * @param string $pref       The column in the wp_users table to update the user's status
+ *                           in (presumably user_status, spam, or deleted).
+ * @param int    $value      The new status for the user.
+ * @param null   $deprecated Deprecated as of 3.0.2 and should not be used.
+ * @return int   The initially passed $value.
+ */
+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 ( $pref == 'spam' ) {
+        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;
+}