WordPress.org

Description

Checks whether username is valid.

Note: 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.

Usage

<?php validate_username( $username ) ?>

Parameters

$username

(string) (required) Username.

Default: None

Return Values

(boolean) 

Returns true if $username is valid, false if $username is invalid.

Examples

<?php
if (!empty($_POST['username']) && validate_username($_POST['username'])) {
  // Go ahead and save the user...
}
?>

Notes

• Uses: apply_filters() Calls validate_username hook on $valid check and $username as parameters.
• Uses: sanitize_user()

Change Log

Since: 2.0.1

Source File

Before 3.0
validate_username() is located in wp-includes/registration.php.

After 3.0
validate_username() is located in wp-includes/user.php.

Related