get_user_id_from_string( string $email_or_login ): int
- Since
- MU (3.0.0)
- Source
wp-includes/ms-deprecated.php:342
Description
A numeric string is considered to be an existing user ID and is simply returned as such.
Compatibility
Deprecated in WordPress 3.6.0. Use get_user_by()
- 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
$email_or_loginstring- Either an email address or a login.
Return value
int
Performance profile
How much work a call to get_user_id_from_string() 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–20
- 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 28.
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 get_user_id_from_string()
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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_user_id_from_string() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_email() && $email_or_login | 13 | _deprecated_function(), is_email() |
| always | 18–20 | _deprecated_function(), is_email(), get_user_by() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 28 | 13–20 | 3 | |
| 8.5 | 28 | 13–20 | 3 | |
| 8.4 | 28 | 13–20 | 3 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 30 | 15–22 | 3 | |
| 8.2 | 30 | 15–22 | 3 | |
| 8.1 | 30 | 15–22 | 3 | |
| 7.4 | 30 | 15–22 | 3 |
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 · 3
- _deprecated_function()Marks a function as deprecated and inform when it has been used.
- is_email()Verifies that an email is valid.
- get_user_by()Retrieves user info by a given field.
Source code
function get_user_id_from_string( $email_or_login ) { _deprecated_function( __FUNCTION__, '3.6.0', 'get_user_by()' ); if ( is_email( $email_or_login ) ) $user = get_user_by( 'email', $email_or_login ); elseif ( is_numeric( $email_or_login ) ) return $email_or_login; else $user = get_user_by( 'login', $email_or_login ); if ( $user ) return $user->ID; return 0;}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.