validate_username( string $username )
Checks whether a username is valid.
Contents
Parameters Parameters
- $username
-
(string) (Required) Username.
Return Return
(bool) Whether username given is valid.
More Information More Information
This function attempts to sanitize the username, and if it “passes”, the name is considered valid. For additional logic, you can use the ‘validate_username‘ hook.
Source Source
File: wp-includes/user.php
function validate_username( $username ) {
$sanitized = sanitize_user( $username, true );
$valid = ( $sanitized == $username && ! empty( $sanitized ) );
/**
* Filters whether the provided username is valid.
*
* @since 2.0.1
*
* @param bool $valid Whether given username is valid.
* @param string $username Username to check.
*/
return apply_filters( 'validate_username', $valid, $username );
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 4.4.0 | Empty sanitized usernames are now considered invalid. |
| 2.0.1 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
Example
if ( ! empty( $_POST['username'] ) && validate_username( $_POST['username'] ) ) { // Go ahead and save the user... }