grant_super_admin() WordPress Function
The grant_super_admin() function allows a user to be granted Super Admin privileges. This function is only available to WordPress Multisite installations. Super Admin is a user who has access to the network administration features of a WordPressMultisite installation.
grant_super_admin( int $user_id ) #
Grants Super Admin privileges.
Parameters
- $user_id
(int)(Required)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.
More Information
Grants super admin privileges:
grant_super_admin( $user_id );
Source
File: wp-includes/capabilities.php
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, true ) ) { $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; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |