username_exists( string $username )
Determines whether the given username exists.
Description
For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.
Parameters
- $username
-
(Required) The username to check for existence.
Return
(int|false) The user ID on success, false on failure.
Source
File: wp-includes/user.php
function username_exists( $username ) {
if ( $user = get_user_by( 'login', $username ) ) {
$user_id = $user->ID;
} else {
$user_id = false;
}
/**
* Filters whether the given username exists or not.
*
* @since WP-4.9.0
*
* @param int|false $user_id The user's ID on success, and false on failure.
* @param string $username Username to check.
*/
return apply_filters( 'username_exists', $user_id, $username );
}
Changelog
Version | Description |
---|---|
2.0.0 | Introduced. |