grant_super_admin( int $user_id ): bool
- Since
- 3.0.0
- Source
wp-includes/capabilities.php:1211
Compatibility
- WordPress
- since 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_idint- ID of the user to be granted Super Admin privileges.
Return value
bool- True on success, false on failure. This can fail when the user is already a super admin or when the
$super_adminsglobal is defined.
Performance profile
How much work a call to grant_super_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
- 4–36
- Plugin surface
- 2 hooks
- 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 38.
Third-party callbacks on 'grant_super_admin', 'granted_super_admin' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
do_action()called directly - optionnetwork option
get_site_option()called directly - querycontent query
get_user_by()one call below grant_super_admin()
Further down the call graph this can also reach 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 grant_super_admin() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
isset($value) | 4 | none |
!isset($value) && !is_multisite() | 7 | is_multisite() |
!isset($value) && is_multisite() | 21–25 | is_multisite(), do_action(), get_site_option(), get_userdata() |
!isset($value) && is_multisite() && !$super_admins | 36 | is_multisite(), do_action(), get_site_option(), get_userdata(), update_site_option(), do_action() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 38 | 4–36 | 4 | |
| 8.5 | 38 | 4–36 | 4 | |
| 8.4 | 38 | 4–36 | 4 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 41 | 4–39 | 4 | |
| 8.2 | 41 | 4–39 | 4 | |
| 8.1 | 41 | 4–39 | 4 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 42 | 5–40 | 4 |
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.
Hooks and filters fired · 2
2 hooks fire while grant_super_admin() runs, in this order:
- do_action( grant_super_admin )actionline 1224 (+13 into the body)
Fires before the user is granted Super Admin privileges.
- do_action( granted_super_admin )actionline 1241 (+30 into the body)
Fires after the user is granted Super Admin privileges.
Uses · 5
- is_multisite()Determines whether Multisite is enabled.
- do_action()Calls the callback functions that have been added to an action hook.
- get_site_option()Retrieve an option value for the current network based on name of option.
- get_userdata()Retrieves user info by user ID.
- update_site_option()Updates the value of an option that was already added for the current network.
Source code
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;}Changelog
Introduced in 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 7.1.0 tag, from
src/wp-includes/capabilities.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.