username_exists() WordPress Function
The username_exists() function is used to check whether a specified username already exists in the WordPress database. This function can be useful for making sure that a chosen username is unique before creating a new user account.
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
(string)(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 ) { $user = get_user_by( 'login', $username ); if ( $user ) { $user_id = $user->ID; } else { $user_id = false; } /** * Filters whether the given username exists. * * @since 4.9.0 * * @param int|false $user_id The user ID associated with the username, * or false if the username does not exist. * @param string $username The username to check for existence. */ return apply_filters( 'username_exists', $user_id, $username ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.0.0 | Introduced. |