get_user_by( string $field, int|string $value )

Retrieves user info by a given field.

Parameters

$field

(Required) The field to retrieve the user with. id | ID | slug | email | login.

$value

(Required) A value for $field. A user ID, slug, email address, or login name.

Return

(WP_User|false) WP_User object on success, false on failure.

Source

File: wp-includes/pluggable.php 

function get_user_by( $field, $value ) {
	$userdata = WP_User::get_data_by( $field, $value );

	if ( !$userdata )
		return false;

	$user = new WP_User;
	$user->init( $userdata );

	return $user;
}

Expand Source Code View on GitHub

Changelog

Changelog
Version Description
4.4.0 Added 'ID' as an alias of 'id' for the $field parameter.
2.8.0 Introduced.