W3cubDocs

/WordPress

WP_REST_Users_Controller::check_username( string $value, WP_REST_Request $request, string $param )

Check a username for the REST API.

Description

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

Parameters

$value

(string) (Required) The username submitted in the request.

$request

(WP_REST_Request) (Required) Full details about the request.

$param

(string) (Required) The parameter name.

Return

(string|WP_Error) The sanitized username, if valid, otherwise an error.

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 

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;
	}

Uses

Uses Description
wp-includes/user.php: illegal_user_logins

Filters the list of disallowed usernames.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/user.php: validate_username()

Checks whether a username is valid.
wp-includes/class-wp-error.php: WP_Error::__construct()

Initialize the error.

Changelog

Version Description
4.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_users_controller/check_username