W3cubDocs

/WordPress

revoke_super_admin( int $user_id )

Revokes Super Admin privileges.

Parameters

$user_id

(int) (Required) 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.

Source

File: wp-includes/capabilities.php 

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' ) ) ) {
		$key = array_search( $user->user_login, $super_admins, true );
		if ( false !== $key ) {
			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;
}

Uses

Uses Description
wp-includes/capabilities.php: revoke_super_admin

Fires before the user’s Super Admin privileges are revoked.
wp-includes/capabilities.php: revoked_super_admin

Fires after the user’s Super Admin privileges are revoked.
wp-includes/pluggable.php: get_userdata()

Retrieve user info by user ID.
wp-includes/load.php: is_multisite()

If Multisite is enabled.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/option.php: update_site_option()

Updates the value of an option that was already added for the current network.
wp-includes/option.php: get_site_option()

Retrieve an option value for the current network based on name of option.

Changelog

Version Description
3.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/revoke_super_admin