Skip to content
Docs
Get RestroPress

Filter

rpress_validate_username

Updated
On this page

Filters whether a username is valid.

Runs in rpress_validate_username(). The default is true when sanitize_user( $username, false ) equals the submitted username, which means it contains no disallowed characters.

Parameters#

ParameterTypeDescription
$validboolWhether the username passed sanitization.
$usernamestringUsername being validated.

Return value#

bool. True if valid.

Example#

function my_reject_reserved_usernames( $valid, $username ) {
	if ( in_array( strtolower( $username ), array( 'admin', 'root' ), true ) ) {
		return false;
	}
	return $valid;
}
add_filter( 'rpress_validate_username', 'my_reject_reserved_usernames', 10, 2 );

Source#

Applied in:

  • includes/user-functions.php (line 284), in rpress_validate_username()

See also#

Was this page helpful?