is_site_admin( string $user_login = '' )
- Since
- MU (3.0.0)
- Source
wp-includes/ms-deprecated.php:64
Description
Plugins should use is_multisite() instead of checking if this function exists to determine if multisite is enabled.
This function must reside in a file included only if is_multisite() due to legacy function_exists() checks to determine if multisite is enabled.
Compatibility
Deprecated in WordPress 3.0.0. Use is_super_admin()
- WordPress
- since MU (3.0.0)
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$user_loginstringoptional- Username for the user to check. Default empty.Default:
''
Performance profile
How much work a call to is_site_admin() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Constant
- Instructions
- 13–21
- Plugin surface
- None
- Called by
- 0
Reaches the database via get_user_by().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 27.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- querycontent query
get_user_by()called directly - hookthird-party callbacks
do_action()one call below is_site_admin()
Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost is_site_admin() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($user_login) | 13 | _deprecated_function(), get_current_user_id() |
empty($user_login) | 16 | _deprecated_function(), get_current_user_id(), is_super_admin() |
!empty($user_login) && !->exists() | 17 | _deprecated_function(), get_user_by(), ->exists() |
!empty($user_login) && ->exists() | 21 | _deprecated_function(), get_user_by(), ->exists(), is_super_admin() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 27 instructions, 13–21 executed per call, 3 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 4
- _deprecated_function()Marks a function as deprecated and inform when it has been used.
- get_current_user_id()Gets the current user's ID.
- get_user_by()Retrieves user info by a given field.
- is_super_admin()Determines whether user is a site admin.
Source code
function is_site_admin( $user_login = '' ) { _deprecated_function( __FUNCTION__, '3.0.0', 'is_super_admin()' ); if ( empty( $user_login ) ) { $user_id = get_current_user_id(); if ( !$user_id ) return false; } else { $user = get_user_by( 'login', $user_login ); if ( ! $user->exists() ) return false; $user_id = $user->ID; } return is_super_admin( $user_id );}Changelog
Introduced in MU (3.0.0). Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 tag, from
src/wp-includes/ms-deprecated.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.