grant_super_admin() │ WP 3.0.0

Grants Super Admin privileges.

Uses: update_site_option()

Hooks from the function

grant_super_admin

granted_super_admin

Return

true|false. 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.

Usage

grant_super_admin( $user_id );

$user_id(int) (required): ID of the user to be granted Super Admin privileges.

Examples

#1 Give super admin rights (caps) to the user with ID 5

It is recommended to call the function only once, not every time the page is generated. Because it changes the value of the option.

grant_super_admin( 5 );

#2 Set super-admin rights (caps) and remove them when activating/deactivating the plugin

register_activation_hook( __FILE__, 'myplugin_activate' );
register_deactivation_hook( __FILE__, 'myplugin_deactivate' );

function myplugin_activate() {

	// give caps
	grant_super_admin( 5 );
}

function myplugin_deactivate(){

	// take away the caps
	revoke_super_admin( 5 );
}

Notes

Global. Array. $super_admins

Changelog

Since 3.0.0

Introduced.

`grant_super_admin() grant super admin` code ^{WP 6.5.2}

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;
}