is_super_admin( int|false $user_id = false ): bool

Determines whether user is a site admin.

Contents

Parameters
Return
Source
Related
- Uses
- Used By
Changelog
User Contributed Notes

Parameters

$user_id int|false Optional: The ID of a user. Defaults to false, to check the current user.

Default: false

Return

bool Whether the user is a site admin.

Source

File: wp-includes/capabilities.php. View all references

function is_super_admin( $user_id = false ) {
	if ( ! $user_id ) {
		$user = wp_get_current_user();
	} else {
		$user = get_userdata( $user_id );
	}

	if ( ! $user || ! $user->exists() ) {
		return false;
	}

	if ( is_multisite() ) {
		$super_admins = get_super_admins();
		if ( is_array( $super_admins ) && in_array( $user->user_login, $super_admins, true ) ) {
			return true;
		}
	} else {
		if ( $user->has_cap( 'delete_users' ) ) {
			return true;
		}
	}

	return false;
}

View on Trac View on GitHub

Uses

Uses
Uses	Description
get_super_admins() wp-includes/capabilities.php	Retrieves a list of super admins.
wp_get_current_user() wp-includes/pluggable.php	Retrieves the current user object.
get_userdata() wp-includes/pluggable.php	Retrieves user info by user ID.
is_multisite() wp-includes/load.php	Determines whether Multisite is enabled.

Show 2 more uses Hide more uses

Used By

Used By
Used By	Description
wp_maybe_grant_site_health_caps() wp-includes/capabilities.php	Filters the user capabilities to grant the ‘view_site_health_checks’ capabilities as necessary.
WP_MS_Users_List_Table::column_cb() wp-admin/includes/class-wp-ms-users-list-table.php	Handles the checkbox column output.
wp_install_defaults() wp-admin/includes/upgrade.php	Creates the initial content for a newly-installed site.
WP_User::has_cap() wp-includes/class-wp-user.php	Returns whether the user has the specified capability.
map_meta_cap() wp-includes/capabilities.php	Maps a capability to the primitive capabilities required of the given user to satisfy the capability being checked.
is_site_admin() wp-includes/ms-deprecated.php	Determine if user is a site admin.
ms_site_check() wp-includes/ms-load.php	Checks status of current blog.

Show 2 more used by Hide more used by

Changelog

Changelog
Version	Description
3.0.0	Introduced.

User Contributed Notes

1

Contributed by Codex — 8 years ago

Example

<?php
// Removes the "Edit" menu for users who are not Super Admins of a multisite network
if ( ! is_super_admin() ) {
	add_action( 'admin_init', 'wpdocs_remove_edit_menu' );
}

/**
 * Remove the profile editing link for non-super admins.
 */
function wpdocs_remove_edit_menu() {
	remove_menu_page('edit.php');
}
?>

Skip to note 2 content

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

Contributed by John Russell — 6 years ago
```
&lt;?php
// As of WordPress 4.8 the use of is_super_admin is discouraged. Use the setup_network capability check instead.
if ( current_user_can( 'setup_network' ) ) {
	// do something
}
?&gt;
```
Log in to add feedback

0

Contributed by tenebralyo — 5 years ago

<?php
// Display hooks for Super admin only
if ( is_super_admin() ) {
$debug_tags = array();
add_action( 'all', function ( $tag ) {
    global $debug_tags;
    if ( in_array( $tag, $debug_tags ) ) {
        return;
    }
    echo "<pre>" . $tag . "</pre>";
    $debug_tags[] = $tag;
} );
}
?>

You must log in before being able to contribute a note or feedback.