Warning: This function has been deprecated. Use get_user_by() instead.
get_user_id_from_string() WordPress Function
The get_user_id_from_string() function accepts a string parameter and returns the user ID of the user specified in the string. If no user is specified in the string, the function returns the current user's ID.
get_user_id_from_string( string $string ) #
Get a numeric user ID from either an email address or a login.
Description
A numeric string is considered to be an existing user ID and is simply returned as such.
See also
Parameters
- $string
(string)(Required)Either an email address or a login.
Return
(int)
Source
File: wp-includes/ms-deprecated.php
function get_user_id_from_string( $string ) {
_deprecated_function( __FUNCTION__, '3.6.0', 'get_user_by()' );
if ( is_email( $string ) )
$user = get_user_by( 'email', $string );
elseif ( is_numeric( $string ) )
return $string;
else
$user = get_user_by( 'login', $string );
if ( $user )
return $user->ID;
return 0;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 3.6.0 | Use get_user_by() |
| MU (3.0.0) | Introduced. |