Changeset 41225

Timestamp:

08/03/2017 09:40:02 PM (7 years ago)

Author:

flixos90

Message:

Multisite: Introduce a can_add_user_to_blog filter to prevent adding a user to a site.

Under certain circumstances, it can be necessary that a user should not be added to a site, beyond the restrictions that WordPress core applies. With the new can_add_user_to_blog filter, plugin developers can run custom checks and return an error in case of a failure, that will prevent the user from being added.

The user-facing parts and the REST API route that interact with add_user_to_blog() have been adjusted accordingly to provide appropriate error feedback when a user could not be added to a site. Furthermore, two existing error feedback messages in the site admin's "New User" screen have been adjusted to properly show inside an error notice instead of a success notice.

Props jmdodd.
Fixes #41101.

Location:

trunk

Files:

• src/wp-admin/network/site-users.php (modified) (3 diffs)
• src/wp-admin/user-new.php (modified) (3 diffs)
• src/wp-includes/ms-functions.php (modified) (4 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-users-controller.php (modified) (1 diff)
• tests/phpunit/tests/user/multisite.php (modified) (1 diff)

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

@@ -67 +67 @@
                     $update = 'err_new_dup';
                 } else {
-                    add_user_to_blog( $id, $user_id, $_POST['new_role'] );
-                    $update = 'newuser';
-                    /**
-                      * Fires after a user has been created via the network site-users.php page.
-                      *
-                      * @since 4.4.0
-                      *
-                      * @param int $user_id ID of the newly created user.
-                      */
-                    do_action( 'network_site_users_created_user', $user_id );
+                    $result = add_user_to_blog( $id, $user_id, $_POST['new_role'] );
+
+                    if ( is_wp_error( $result ) ) {
+                        $update = 'err_add_fail';
+                    } else {
+                        $update = 'newuser';
+                        /**
+                          * Fires after a user has been created via the network site-users.php page.
+                          *
+                          * @since 4.4.0
+                          *
+                          * @param int $user_id ID of the newly created user.
+                          */
+                        do_action( 'network_site_users_created_user', $user_id );
+                    }
                 }
             }
@@ -88 +93 @@
                 $user = get_user_by( 'login', $newuser );
                 if ( $user && $user->exists() ) {
-                    if ( ! is_user_member_of_blog( $user->ID, $id ) )
-                        add_user_to_blog( $id, $user->ID, $_POST['new_role'] );
-                    else
+                    if ( ! is_user_member_of_blog( $user->ID, $id ) ) {
+                        $result = add_user_to_blog( $id, $user->ID, $_POST['new_role'] );
+
+                        if ( is_wp_error( $result ) ) {
+                            $update = 'err_add_fail';
+                        }
+                    } else {
                         $update = 'err_add_member';
+                    }
                 } else {
                     $update = 'err_add_notfound';
@@ -224 +234 @@
         echo '<div id="message" class="error notice is-dismissible"><p>' . __( 'User is already a member of this site.' ) . '</p></div>';
         break;
+    case 'err_add_fail':
+        echo '<div id="message" class="error notice is-dismissible"><p>' . __( 'User could not be added to this site.' ) . '</p></div>';
+        break;
     case 'err_add_notfound':
         echo '<div id="message" class="error notice is-dismissible"><p>' . __( 'Enter the username of an existing user.' ) . '</p></div>';

trunk/src/wp-admin/user-new.php

@@ -68 +68 @@
     } else {
         if ( isset( $_POST[ 'noconfirmation' ] ) && current_user_can( 'manage_network_users' ) ) {
-            add_existing_user_to_blog( array( 'user_id' => $user_id, 'role' => $_REQUEST[ 'role' ] ) );
-            $redirect = add_query_arg( array( 'update' => 'addnoconfirmation' , 'user_id' => $user_id ), 'user-new.php' );
+            $result = add_existing_user_to_blog( array( 'user_id' => $user_id, 'role' => $_REQUEST[ 'role' ] ) );
+
+            if ( ! is_wp_error( $result ) ) {
+                $redirect = add_query_arg( array( 'update' => 'addnoconfirmation', 'user_id' => $user_id ), 'user-new.php' );
+            } else {
+                $redirect = add_query_arg( array( 'update' => 'could_not_add' ), 'user-new.php' );
+            }
         } else {
             $newuser_key = substr( md5( $user_id ), 0, 5 );
@@ -158 +163 @@
                 if ( is_wp_error( $new_user ) ) {
                     $redirect = add_query_arg( array( 'update' => 'addnoconfirmation' ), 'user-new.php' );
+                } elseif ( ! is_user_member_of_blog( $new_user['user_id'] ) ) {
+                    $redirect = add_query_arg( array( 'update' => 'created_could_not_add' ), 'user-new.php' );
                 } else {
                     $redirect = add_query_arg( array( 'update' => 'addnoconfirmation', 'user_id' => $new_user['user_id'] ), 'user-new.php' );
@@ -262 +269 @@
                 $messages[] = __('That user is already a member of this site.');
                 break;
+            case "could_not_add":
+                $add_user_errors = new WP_Error( 'could_not_add', __( 'That user could not be added to this site.' ) );
+                break;
+            case "created_could_not_add":
+                $add_user_errors = new WP_Error( 'created_could_not_add', __( 'User has been created, but could not be added to this site.' ) );
+                break;
             case "does_not_exist":
-                $messages[] = __('The requested user does not exist.');
+                $add_user_errors = new WP_Error( 'does_not_exist', __( 'The requested user does not exist.' ) );
                 break;
             case "enter_email":
-                $messages[] = __('Please enter a valid email address.');
+                $add_user_errors = new WP_Error( 'enter_email', __( 'Please enter a valid email address.' ) );
                 break;
         }

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

@@ -60 +60 @@
     } else {
         //TODO Review this call to add_user_to_blog too - to get here the user must have a role on this blog?
-        add_user_to_blog( $first_blog->userblog_id, $user_id, 'subscriber' );
-        update_user_meta( $user_id, 'primary_blog', $first_blog->userblog_id );
-        $primary = $first_blog;
+        $result = add_user_to_blog( $first_blog->userblog_id, $user_id, 'subscriber' );
+
+        if ( ! is_wp_error( $result ) ) {
+            update_user_meta( $user_id, 'primary_blog', $first_blog->userblog_id );
+            $primary = $first_blog;
+        }
     }
 
@@ -159 +162 @@
         restore_current_blog();
         return new WP_Error( 'user_does_not_exist', __( 'The requested user does not exist.' ) );
+    }
+
+    /**
+     * Filters whether a user should be added to a site.
+     *
+     * @since 4.9.0
+     *
+     * @param bool|WP_Error $retval  True if the user should be added to the site, false
+     *                               or error object otherwise.
+     * @param int           $user_id User ID.
+     * @param string        $role    User role.
+     * @param int           $blog_id Site ID.
+     */
+    $can_add_user = apply_filters( 'can_add_user_to_blog', true, $user_id, $role, $blog_id );
+
+    if ( true !== $can_add_user ) {
+        restore_current_blog();
+
+        if ( is_wp_error( $can_add_user ) ) {
+            return $can_add_user;
+        }
+
+        return new WP_Error( 'user_cannot_be_added', __( 'User cannot be added to this site.' ) );
     }
 
@@ -2082 +2108 @@
         $blog_id = get_current_blog_id();
         $result = add_user_to_blog( $blog_id, $details[ 'user_id' ], $details[ 'role' ] );
-        /**
-         * Fires immediately after an existing user is added to a site.
-         *
-         * @since MU (3.0.0)
-         *
-         * @param int   $user_id User ID.
-         * @param mixed $result  True on success or a WP_Error object if the user doesn't exist.
-         */
-        do_action( 'added_existing_user', $details['user_id'], $result );
+
+        if ( ! is_wp_error( $result ) ) {
+            /**
+             * Fires immediately after an existing user is added to a site.
+             *
+             * @since MU (3.0.0)
+             *
+             * @param int   $user_id User ID.
+             * @param mixed $result  True on success or a WP_Error object if the user doesn't exist.
+             */
+            do_action( 'added_existing_user', $details['user_id'], $result );
+        }
+
         return $result;
     }
@@ -2112 +2142 @@
         $blog_id = $meta[ 'add_to_blog' ];
         $role = $meta[ 'new_role' ];
-        remove_user_from_blog($user_id, get_network()->site_id); // remove user from main blog.
-        add_user_to_blog( $blog_id, $user_id, $role );
-        update_user_meta( $user_id, 'primary_blog', $blog_id );
+        remove_user_from_blog( $user_id, get_network()->site_id ); // remove user from main blog.
+
+        $result = add_user_to_blog( $blog_id, $user_id, $role );
+
+        if ( ! is_wp_error( $result ) ) {
+            update_user_meta( $user_id, 'primary_blog', $blog_id );
+        }
     }
 }

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

@@ -493 +493 @@
             }
 
-            add_user_to_blog( get_site()->id, $user_id, '' );
+            $result= add_user_to_blog( get_site()->id, $user_id, '' );
+            if ( is_wp_error( $result ) ) {
+                return $result;
+            }
         } else {
             $user_id = wp_insert_user( wp_slash( (array) $user ) );

trunk/tests/phpunit/tests/rest-api/rest-users-controller.php

@@ -1019 +1019 @@
 
         $this->assertFalse( $user_is_member );
+    }
+
+    /**
+     * @ticket 41101
+     * @group ms-required
+     */
+    public function test_create_new_network_user_with_add_user_to_blog_failure() {
+        $this->allow_user_to_manage_multisite();
+
+        $params = array(
+            'username' => 'testuser123',
+            'password' => 'testpassword',
+            'email'    => 'test@example.com',
+            'name'     => 'Test User 123',
+            'roles'    => array( 'editor' ),
+        );
+
+        add_filter( 'can_add_user_to_blog', '__return_false' );
+
+        $request = new WP_REST_Request( 'POST', '/wp/v2/users' );
+        $request->add_header( 'content-type', 'application/x-www-form-urlencoded' );
+        $request->set_body_params( $params );
+        $response = $this->server->dispatch( $request );
+        $this->assertErrorResponse( 'user_cannot_be_added', $response );
     }
 

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

@@ -396 +396 @@
 
         $this->assertWPError( $result );
+    }
+
+    /**
+     * @ticket 41101
+     */
+    public function test_should_fail_can_add_user_to_blog_filter() {
+        $site_id = self::factory()->blog->create();
+        $user_id = self::factory()->user->create();
+
+        add_filter( 'can_add_user_to_blog', '__return_false' );
+        $result = add_user_to_blog( $site_id, $user_id, 'subscriber' );
+
+        $this->assertWPError( $result );
+    }
+
+    /**
+     * @ticket 41101
+     */
+    public function test_should_succeed_can_add_user_to_blog_filter() {
+        $site_id = self::factory()->blog->create();
+        $user_id = self::factory()->user->create();
+
+        add_filter( 'can_add_user_to_blog', '__return_true' );
+        $result = add_user_to_blog( $site_id, $user_id, 'subscriber' );
+
+        $this->assertTrue( $result );
     }