WP_CLI\Fetchers

User::getpublicWP-CLI 1.0

Get a user object by one of its identifying attributes.

Method of the class: User{}

No Hooks.

Returns

WP_User|false. The item if found; false otherwise.

Usage

$User = new User();
$User->get( $arg );
$arg(string) (required)
The raw CLI argument.

User::get() code WP-CLI 2.13.0-alpha

public function get( $arg ) {

	if ( getenv( 'WP_CLI_FORCE_USER_LOGIN' ) ) {
		$this->msg = "Invalid user login: '%s'";
		return get_user_by( 'login', $arg );
	}

	if ( is_numeric( $arg ) ) {
		$check = get_user_by( 'login', $arg );
		$user  = get_user_by( 'id', $arg );
		if ( $check && $user ) {
			WP_CLI::warning(
				sprintf(
					'Ambiguous user match detected (both ID and user_login exist for identifier \'%d\'). WP-CLI will default to the ID, but you can force user_login instead with WP_CLI_FORCE_USER_LOGIN=1.',
					$arg
				)
			);
		}
	} elseif ( is_email( $arg ) ) {
		$user = get_user_by( 'email', $arg );
		// Logins can be emails.
		if ( ! $user ) {
			$user = get_user_by( 'login', $arg );
		}
	} else {
		$user = get_user_by( 'login', $arg );
	}

	return $user;
}