is_super_admin

function

is_super_admin( int $user_id = false )

Determine if user is a site admin.

Contents

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

Description Description

Parameters Parameters

$user_id

(int) (Optional) (Optional) The ID of a user. Defaults to the current user.

Default value: false

Return Return

(bool) True if the user is a site admin.

Source Source

File: wp-includes/capabilities.php

function is_super_admin( $user_id = false ) {
	if ( ! $user_id || $user_id == get_current_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 ) ) {
			return true;
		}
	} else {
		if ( $user->has_cap( 'delete_users' ) ) {
			return true;
		}
	}

	return false;
}

Expand full source code Collapse full source code View on Trac

Changelog Changelog

Changelog
Version	Description
3.0.0	Introduced.

Uses Uses

Uses
Uses	Description
wp-includes/capabilities.php: get_super_admins()	Retrieve a list of super admins.
wp-includes/pluggable.php: wp_get_current_user()	Retrieve the current user object.
wp-includes/pluggable.php: get_userdata()	Retrieve user info by user ID.
wp-includes/load.php: is_multisite()	If Multisite is enabled.
wp-includes/user.php: get_current_user_id()	Get the current user’s ID

Used By Used By

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

Show 2 more used by Hide more used by

User Contributed Notes User Contributed Notes

1

Contributed by Codex — 4 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');
}
?>

Expand full source code Collapse full source code

Skip to note 2 content
You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Contributed by John Russell — 2 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
}
?>
```
Log in to add feedback

0

Contributed by tenebralyo — 10 months 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.

Keep Leading Your Followers!
Share it for them.