Changeset 27706

Timestamp:

03/25/2014 12:13:40 PM (11 years ago)

Author:

nacin

Message:

Multisite: Don't set the $super_admins global in grant_super_admin(), revoke_super_admin().

Adds tests and docs.

props jdgrimes.
see #27205.

Location:

trunk

Files:

• src/wp-admin/includes/ms.php (modified) (2 diffs)
• tests/phpunit/tests/ms.php (modified) (1 diff)

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

@@ -687 +687 @@
  * @since 3.0.0
  * @param int $user_id ID of the user to be granted Super Admin privileges.
+ * @return bool True on success, false on failure. This can fail when the user is
+ *              already a super admin or when the $super_admins global is defined.
  */
 function grant_super_admin( $user_id ) {
-    global $super_admins;
-
     // If global super_admins override is defined, there is nothing to do here.
-    if ( isset( $super_admins ) )
+    if ( isset( $GLOBALS['super_admins'] ) ) {
         return false;
+    }
 
     /**
@@ -730 +731 @@
  * @since 3.0.0
  * @param int $user_id ID of the user Super Admin privileges to be revoked from.
+ * @return bool True on success, false on failure. This can fail when the user's email
+ *              is the network admin email or when the $super_admins global is defined.
  */
 function revoke_super_admin( $user_id ) {
-    global $super_admins;
-
     // If global super_admins override is defined, there is nothing to do here.
-    if ( isset( $super_admins ) )
+    if ( isset( $GLOBALS['super_admins'] ) ) {
         return false;
+    }
 
     /**

trunk/tests/phpunit/tests/ms.php

@@ -1301 +1301 @@
         $this->assertQueryTrue( 'is_author', 'is_archive' );
     }
+
+    /**
+     * @ticket 27205
+     */
+    function test_granting_super_admins() {
+        if ( isset( $GLOBALS['super_admins'] ) ) {
+            $old_global = $GLOBALS['super_admins'];
+            unset( $GLOBALS['super_admins'] );
+        }
+
+        $user_id = $this->factory->user->create();
+
+        $this->assertFalse( is_super_admin( $user_id ) );
+        $this->assertFalse( revoke_super_admin( $user_id ) );
+        $this->assertTrue( grant_super_admin( $user_id ) );
+        $this->assertTrue( is_super_admin( $user_id ) );
+        $this->assertFalse( grant_super_admin( $user_id ) );
+        $this->assertTrue( revoke_super_admin( $user_id ) );
+
+        // None of these operations should set the $super_admins global.
+        $this->assertFalse( isset( $GLOBALS['super_admins'] ) );
+
+        // Try with two users.
+        $second_user = $this->factory->user->create();
+        $this->assertTrue( grant_super_admin( $user_id ) );
+        $this->assertTrue( grant_super_admin( $second_user ) );
+        $this->assertTrue( is_super_admin( $second_user ) );
+        $this->assertTrue( is_super_admin( $user_id ) );
+        $this->assertTrue( revoke_super_admin( $user_id ) );
+        $this->assertTrue( revoke_super_admin( $second_user ) );
+
+        if ( isset( $old_global ) ) {
+            $GLOBALS['super_admins'] = $old_global;
+        }
+    }
 }