maybe_add_existing_user_to_blog()
- Since
- MU (3.0.0)
- Source
wp-includes/ms-functions.php:2222
Description
This will only work when the user's details are saved as an option keyed as 'newuser{key}', where '{key}' is a hash generated for the user to be added, as when a user is invited through the regular WP Add User interface.
Compatibility
- 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.
Performance profile
How much work a call to maybe_add_existing_user_to_blog() 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
- Moderate
- Scaling
- Constant
- Instructions
- 5–74
- Plugin surface
- None
- Called by
- 0
Reads stored settings via get_option(), cached per request but not free on a cold cache.
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 75.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()one call below maybe_add_existing_user_to_blog() - cacheobject cache
wp_cache_get()one call below maybe_add_existing_user_to_blog() - serializeserialisation
maybe_unserialize()one call below maybe_add_existing_user_to_blog()
Further down the call graph this can also reach query 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 · 13 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost maybe_add_existing_user_to_blog() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 5 | none |
$key !== "" && !is_wp_error() | 54 | explode(), array_pop(), get_option(), add_existing_user_to_blog(), is_wp_error(), __(), home_url(), admin_url(), sprintf(), __(), wp_die() |
$key !== "" && !empty($details) && !is_wp_error() | 58 | explode(), array_pop(), get_option(), delete_option(), add_existing_user_to_blog(), is_wp_error(), __(), home_url(), admin_url(), sprintf(), __(), wp_die() |
$key === "" && !is_wp_error() | 58 | explode(), array_pop(), array_pop(), get_option(), add_existing_user_to_blog(), is_wp_error(), __(), home_url(), admin_url(), sprintf(), __(), wp_die() |
$key !== "" && empty($details) | 59 | explode(), array_pop(), get_option(), __(), home_url(), sprintf(), wp_die(), __(), home_url(), admin_url(), sprintf(), __(), wp_die() |
$key === "" && !empty($details) && !is_wp_error() | 62 | explode(), array_pop(), array_pop(), get_option(), delete_option(), add_existing_user_to_blog(), is_wp_error(), __(), home_url(), admin_url(), sprintf(), __(), wp_die() |
$key !== "" | 63 | explode(), array_pop(), get_option(), delete_option(), __(), home_url(), sprintf(), wp_die(), __(), home_url(), admin_url(), sprintf(), __(), wp_die() |
$key === "" && empty($details) | 63 | explode(), array_pop(), array_pop(), get_option(), __(), home_url(), sprintf(), wp_die(), __(), home_url(), admin_url(), sprintf(), __(), wp_die() |
$key !== "" && is_wp_error() | 66 | explode(), array_pop(), get_option(), add_existing_user_to_blog(), is_wp_error(), __(), home_url(), sprintf(), wp_die(), __(), home_url(), admin_url(), sprintf(), __(), wp_die() |
$key === "" | 67 | explode(), array_pop(), array_pop(), get_option(), delete_option(), __(), home_url(), sprintf(), wp_die(), __(), home_url(), admin_url(), sprintf(), __(), wp_die() |
$key !== "" && !empty($details) && is_wp_error() | 70 | explode(), array_pop(), get_option(), delete_option(), add_existing_user_to_blog(), is_wp_error(), __(), home_url(), sprintf(), wp_die(), __(), home_url(), admin_url(), sprintf(), __(), wp_die() |
$key === "" && is_wp_error() | 70 | explode(), array_pop(), array_pop(), get_option(), add_existing_user_to_blog(), is_wp_error(), __(), home_url(), sprintf(), wp_die(), __(), home_url(), admin_url(), sprintf(), __(), wp_die() |
1 further outcome, up to 74 instructions
$key === "" && !empty($details) && is_wp_error() | 74 | explode(), array_pop(), array_pop(), get_option(), delete_option(), add_existing_user_to_blog(), is_wp_error(), __(), home_url(), sprintf(), wp_die(), __(), home_url(), admin_url(), sprintf(), __(), wp_die() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 75 | 5–74 | 5 | |
| 8.5 | 75 | 5–74 | 5 | |
| 8.4 | 75 | 5–74 | 5 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 78 | 8–77 | 5 | |
| 8.2 | 78 | 8–77 | 5 | |
| 8.1 | 78 | 8–77 | 5 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 79 | 9–78 | 5 |
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 · 9
- str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
- get_option()Retrieves an option value based on an option name.
- delete_option()Removes an option by name. Prevents removal of protected WordPress options.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- add_existing_user_to_blog()Adds a user to a blog based on details from maybe_add_existing_user_to_blog().
- wp_die()Kills WordPress execution and displays HTML page with an error message.
- __()Retrieves the translation of $text.
- home_url()Retrieves the URL for the current site where the front end is accessible.
- admin_url()Retrieves the URL to the admin area for the current site.
Source code
function maybe_add_existing_user_to_blog() { if ( ! str_contains( $_SERVER['REQUEST_URI'], '/newbloguser/' ) ) { return; } $parts = explode( '/', $_SERVER['REQUEST_URI'] ); $key = array_pop( $parts ); if ( '' === $key ) { $key = array_pop( $parts ); } $details = get_option( 'new_user_' . $key ); if ( ! empty( $details ) ) { delete_option( 'new_user_' . $key ); } if ( empty( $details ) || is_wp_error( add_existing_user_to_blog( $details ) ) ) { wp_die( sprintf( /* translators: %s: Home URL. */ __( 'An error occurred adding you to this site. Go to the <a href="%s">homepage</a>.' ), home_url() ) ); } wp_die( sprintf( /* translators: 1: Home URL, 2: Admin URL. */ __( 'You have been added to this site. Please visit the <a href="%1$s">homepage</a> or <a href="%2$s">log in</a> using your username and password.' ), home_url(), admin_url() ), __( 'WordPress › Success' ), array( 'response' => 200 ) );}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-functions.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.