Changeset 37200 for trunk/src/wp-includes/capabilities.php

Timestamp:

04/14/2016 03:34:07 AM (10 years ago)

Author:

jeremyfelt

Message:

Multisite: Relocate revoke_super_admin() and grant_super_admin()

Moving these functions to wp-includes/capabilities.php allows plugins to access more than just is_super_admin() and get_super_admin() from the front end without including a file via wp-admin/. Add an is_multisite() check to prevent use of these on single site environments now that they have left ms.php..

Props johnjamesjacoby.
Fixes #21788.

File:

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

trunk/src/wp-includes/capabilities.php

@@ -620 +620 @@
         return false;
 }
+
+/**
+ * Grants Super Admin privileges.
+ *
+ * @since 3.0.0
+ *
+ * @global array $super_admins
+ *
+ * @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 ) {
+        // If global super_admins override is defined, there is nothing to do here.
+        if ( isset( $GLOBALS['super_admins'] ) || ! is_multisite() ) {
+                return false;
+        }
+
+        /**
+         * Fires before the user is granted Super Admin privileges.
+         *
+         * @since 3.0.0
+         *
+         * @param int $user_id ID of the user that is about to be granted Super Admin privileges.
+         */
+        do_action( 'grant_super_admin', $user_id );
+
+        // Directly fetch site_admins instead of using get_super_admins()
+        $super_admins = get_site_option( 'site_admins', array( 'admin' ) );
+
+        $user = get_userdata( $user_id );
+        if ( $user && ! in_array( $user->user_login, $super_admins ) ) {
+                $super_admins[] = $user->user_login;
+                update_site_option( 'site_admins' , $super_admins );
+
+                /**
+                 * Fires after the user is granted Super Admin privileges.
+                 *
+                 * @since 3.0.0
+                 *
+                 * @param int $user_id ID of the user that was granted Super Admin privileges.
+                 */
+                do_action( 'granted_super_admin', $user_id );
+                return true;
+        }
+        return false;
+}
+
+/**
+ * Revokes Super Admin privileges.
+ *
+ * @since 3.0.0
+ *
+ * @global array $super_admins
+ *
+ * @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 ) {
+        // If global super_admins override is defined, there is nothing to do here.
+        if ( isset( $GLOBALS['super_admins'] ) || ! is_multisite() ) {
+                return false;
+        }
+
+        /**
+         * Fires before the user's Super Admin privileges are revoked.
+         *
+         * @since 3.0.0
+         *
+         * @param int $user_id ID of the user Super Admin privileges are being revoked from.
+         */
+        do_action( 'revoke_super_admin', $user_id );
+
+        // Directly fetch site_admins instead of using get_super_admins()
+        $super_admins = get_site_option( 'site_admins', array( 'admin' ) );
+
+        $user = get_userdata( $user_id );
+        if ( $user && 0 !== strcasecmp( $user->user_email, get_site_option( 'admin_email' ) ) ) {
+                if ( false !== ( $key = array_search( $user->user_login, $super_admins ) ) ) {
+                        unset( $super_admins[$key] );
+                        update_site_option( 'site_admins', $super_admins );
+
+                        /**
+                         * Fires after the user's Super Admin privileges are revoked.
+                         *
+                         * @since 3.0.0
+                         *
+                         * @param int $user_id ID of the user Super Admin privileges were revoked from.
+                         */
+                        do_action( 'revoked_super_admin', $user_id );
+                        return true;
+                }
+        }
+        return false;
+}