Changeset 47173

Timestamp:

02/04/2020 07:34:27 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Users: In remove_user_from_blog():

• Change default value of the $blog_id parameter to match the documented type.
• Change the type of the $reassign parameter for consistency with $user_id and $blog_id.
• Add documentation for the return value.

See #49361.

Location:

trunk/src

Files:

• wp-admin/network/users.php (modified) (1 diff)
• wp-includes/ms-functions.php (modified) (3 diffs)

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

@@ -159 +159 @@
 
                         if ( ! empty( $_POST['delete'] ) && 'reassign' == $_POST['delete'][ $blogid ][ $id ] ) {
-                            remove_user_from_blog( $id, $blogid, $user_id );
+                            remove_user_from_blog( $id, $blogid, (int) $user_id );
                         } else {
                             remove_user_from_blog( $id, $blogid );

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

@@ -235 +235 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param int    $user_id  ID of the user you're removing.
- * @param int    $blog_id  ID of the blog you're removing the user from.
- * @param string $reassign Optional. A user to whom to reassign posts.
- * @return true|WP_Error
- */
-function remove_user_from_blog( $user_id, $blog_id = '', $reassign = '' ) {
+ * @param int $user_id  ID of the user you're removing.
+ * @param int $blog_id  Optional. ID of the blog you're removing the user from. Default 0.
+ * @param int $reassign Optional. ID of the user to whom to reassign posts. Default 0.
+ * @return true|WP_Error True on success or a WP_Error object if the user doesn't exist.
+ */
+function remove_user_from_blog( $user_id, $blog_id = 0, $reassign = 0 ) {
     global $wpdb;
+
     switch_to_blog( $blog_id );
     $user_id = (int) $user_id;
+
     /**
      * Fires before a user is removed from a site.
@@ -254 +256 @@
     do_action( 'remove_user_from_blog', $user_id, $blog_id );
 
-    // If being removed from the primary blog, set a new primary if the user is assigned
-    // to multiple blogs.
+    // If being removed from the primary blog, set a new primary
+    // if the user is assigned to multiple blogs.
     $primary_blog = get_user_meta( $user_id, 'primary_blog', true );
     if ( $primary_blog == $blog_id ) {
@@ -289 +291 @@
     }
 
-    if ( $reassign != '' ) {
+    if ( $reassign ) {
         $reassign = (int) $reassign;
         $post_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_author = %d", $user_id ) );