Check a username for the REST API.

Description

Performs a couple of checks like edit_user() in wp-admin/includes/user.php.

Parameters

$valuestringrequired

The username submitted in the request.

$requestWP_REST_Requestrequired

Full details about the request.

$paramstringrequired

The parameter name.

Return

Source

public function check_username( $value, $request, $param ) {
	$username = (string) $value;

	if ( ! validate_username( $username ) ) {
		return new WP_Error(
			'rest_user_invalid_username',
			__( 'This username is invalid because it uses illegal characters. Please enter a valid username.' ),
			array( 'status' => 400 )
		);
	}

	/** This filter is documented in wp-includes/user.php */
	$illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );

	if ( in_array( strtolower( $username ), array_map( 'strtolower', $illegal_logins ), true ) ) {
		return new WP_Error(
			'rest_user_invalid_username',
			__( 'Sorry, that username is not allowed.' ),
			array( 'status' => 400 )
		);
	}

	return $username;
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘illegal_user_logins’, array $usernames )

Filters the list of disallowed usernames.

Changelog