Changeset 45708

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.

Location:

trunk

Files:

• src/wp-admin/includes/ms.php (modified) (1 diff)
• src/wp-admin/network/users.php (modified) (2 diffs)
• src/wp-includes/ms-deprecated.php (modified) (1 diff)
• src/wp-includes/user.php (modified) (7 diffs)
• tests/phpunit/tests/user/multisite.php (modified) (1 diff)
• tests/phpunit/tests/user/wpAuthenticateSpamCheck.php (modified) (1 diff)

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

@@ -302 +302 @@
     </tr>
     <?php
-}
-
-/**
- * Update the status of a user in the database.
- *
- * Used in core to mark a user as spam or "ham" (not spam) in Multisite.
- *
- * @since 3.0.0
- *
- * @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;
-
-    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;
 }
 

trunk/src/wp-admin/network/users.php

@@ -77 +77 @@
                                 $userfunction = 'all_spam';
                                 $blogs        = get_blogs_of_user( $user_id, true );
+
                                 foreach ( (array) $blogs as $details ) {
                                     if ( $details->userblog_id != get_network()->site_id ) { // main blog not a spam !
@@ -82 +83 @@
                                     }
                                 }
-                                update_user_status( $user_id, 'spam', '1' );
+
+                                $user_data         = $user->to_array();
+                                $user_data['spam'] = '1';
+
+                                wp_update_user( $user_data );
                                 break;
 
                             case 'notspam':
+                                $user = get_userdata( $user_id );
+
                                 $userfunction = 'all_notspam';
                                 $blogs        = get_blogs_of_user( $user_id, true );
+
                                 foreach ( (array) $blogs as $details ) {
                                     update_blog_status( $details->userblog_id, 'spam', '0' );
                                 }
 
-                                update_user_status( $user_id, 'spam', '0' );
+                                $user_data         = $user->to_array();
+                                $user_data['spam'] = '0';
+
+                                wp_update_user( $user_data );
                                 break;
                         }

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;
+}

trunk/src/wp-includes/user.php

@@ -1469 +1469 @@
  * Most of the `$userdata` array fields have filters associated with the values. Exceptions are
  * 'ID', 'rich_editing', 'syntax_highlighting', 'comment_shortcuts', 'admin_color', 'use_ssl',
- * 'user_registered', and 'role'. The filters have the prefix 'pre_user_' followed by the field
- * name. An example using 'description' would have the filter called, 'pre_user_description' that
- * can be hooked into.
+ * 'user_registered', 'spam', and 'role'. The filters have the prefix 'pre_user_' followed by the
+ * field name. An example using 'description' would have the filter called, 'pre_user_description'
+ * that can be hooked into.
  *
  * @since 2.0.0
@@ -1477 +1477 @@
  *              methods for new installations. See wp_get_user_contact_methods().
  * @since 4.7.0 The user's locale can be passed to `$userdata`.
+ * @since 5.3.0 The `spam` field can be passed to `$userdata` (Multisite only).
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -1510 +1511 @@
  *                                             https. Default false.
  *     @type string      $user_registered      Date the user registered. Format is 'Y-m-d H:i:s'.
+ *     @type bool        $spam                 Multisite only. Whether the user is marked as spam.
+ *                                             Default false.
  *     @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user on the
  *                                             site's front end. Default true.
@@ -1645 +1648 @@
         return new WP_Error( 'existing_user_email', __( 'Sorry, that email address is already used!' ) );
     }
+
+    if ( isset( $userdata['spam'] ) && ! is_multisite() ) {
+        return new WP_Error( 'no_spam', __( 'Sorry, marking a user as spam is only supported on Multisite.' ) );
+    }
+
+    $spam = empty( $userdata['spam'] ) ? 0 : (bool) $userdata['spam'];
+
     $nickname = empty( $userdata['nickname'] ) ? $user_login : $userdata['nickname'];
 
@@ -1724 +1734 @@
     $meta['admin_color'] = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $admin_color );
 
-    $meta['use_ssl'] = empty( $userdata['use_ssl'] ) ? 0 : $userdata['use_ssl'];
+    $meta['use_ssl'] = empty( $userdata['use_ssl'] ) ? 0 : (bool) $userdata['use_ssl'];
 
     $user_registered = empty( $userdata['user_registered'] ) ? gmdate( 'Y-m-d H:i:s' ) : $userdata['user_registered'];
@@ -1751 +1761 @@
     if ( ! $update ) {
         $data = $data + compact( 'user_login' );
+    }
+
+    if ( is_multisite() ) {
+        $data = $data + compact( 'spam' );
     }
 
@@ -1849 +1863 @@
          */
         do_action( 'profile_update', $user_id, $old_user_data );
+
+        if ( isset( $userdata['spam'] ) && $userdata['spam'] != $old_user_data->spam ) {
+            if ( $userdata['spam'] == 1 ) {
+                /**
+                 * Fires after the user is marked as a SPAM user.
+                 *
+                 * @since 3.0.0
+                 *
+                 * @param int $user_id ID of the user marked as SPAM.
+                 */
+                do_action( 'make_spam_user', $user_id );
+            } else {
+                /**
+                 * Fires after the user is marked as a HAM user. Opposite of SPAM.
+                 *
+                 * @since 3.0.0
+                 *
+                 * @param int $user_id ID of the user marked as HAM.
+                 */
+                do_action( 'make_ham_user', $user_id );
+            }
+        }
     } else {
         /**

trunk/tests/phpunit/tests/user/multisite.php

@@ -213 +213 @@
                 )
             );
-            update_user_status( $spam_user_id, 'spam', '1' );
+            wp_update_user( array( 'ID' => $spam_user_id, 'spam' => '1' ) );
 
             $this->assertTrue( is_user_spammy( $spam_username ) );

trunk/tests/phpunit/tests/user/wpAuthenticateSpamCheck.php

@@ -35 +35 @@
     function test_wp_authenticate_spam_check_returns_wp_error_when_flagged() {
         $user_id = self::factory()->user->create( array( 'role' => 'contributor' ) );
-        update_user_status( $user_id, 'spam', 1 );
+        wp_update_user( array( 'ID' => $user_id, 'spam' => '1' ) );
         $user        = new WP_User( $user_id );
         $actual_user = wp_authenticate_spam_check( $user );