get_user_by() – Function | Developer.WordPress.org

Retrieves user info by a given field.

Parameters

$fieldstringrequired: The field to retrieve the user with. id | ID | slug | email | login.
$valueint|stringrequired: 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

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

View all references View on Trac View on GitHub

Uses	Description
WP_User::get_data_by()`wp-includes/class-wp-user.php`	Returns only the main user fields.
WP_User::__construct()`wp-includes/class-wp-user.php`	Constructor.

Used by	Description
get_user()`wp-includes/user.php`	Retrieves user info by user ID.
WP_REST_Templates_Controller::get_wp_templates_author_text_field()`wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php`	Returns a human readable text for the author of the template.
wpmu_new_site_admin_notification()`wp-includes/ms-functions.php`	Notifies the Multisite network administrator that a new site was created.
wp_authenticate_application_password()`wp-includes/user.php`	Authenticates the user using an application password.
WP_Automatic_Updater::send_plugin_theme_email()`wp-admin/includes/class-wp-automatic-updater.php`	Sends an email upon the completion or failure of a plugin or theme background update.
populate_network_meta()`wp-admin/includes/schema.php`	Creates WordPress network meta and sets the default values.
get_object_subtype()`wp-includes/meta.php`	Returns the object subtype for a given object ID of a specific type.
wp_create_user_request()`wp-includes/user.php`	Creates and logs a user request to perform a specific action.
wp_user_personal_data_exporter()`wp-includes/user.php`	Finds and exports personal data associated with an email address from the user and user_meta table.
_wp_personal_data_handle_actions()`wp-admin/includes/privacy-tools.php`	Handle list table actions.
WP_REST_Users_Controller::create_item()`wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php`	Creates a single user.
WP_REST_Users_Controller::update_item()`wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php`	Updates a single user.
wp_authenticate_email_password()`wp-includes/user.php`	Authenticates a user using the email and password.
get_avatar_data()`wp-includes/link-template.php`	Retrieves default data about the avatar.
retrieve_password()`wp-includes/user.php`	Handles sending a password retrieval email to a user.
WP_Automatic_Updater::send_email()`wp-admin/includes/class-wp-automatic-updater.php`	Sends an email upon the completion or failure of a background core update.
WP_Automatic_Updater::send_debug_email()`wp-admin/includes/class-wp-automatic-updater.php`	Prepares and sends an email of a full log of background update results, useful for debugging and geekery.
wp_password_change_notification()`wp-includes/pluggable.php`	Notifies the blog admin of a user changing password, normally via email.
wp_new_user_notification()`wp-includes/pluggable.php`	Emails login credentials to a newly-registered user.
wp_notify_postauthor()`wp-includes/pluggable.php`	Notifies an author (and/or others) of a comment/trackback/pingback on a post.
wp_notify_moderator()`wp-includes/pluggable.php`	Notifies the moderator of the site about a new comment that is awaiting approval.
wp_validate_auth_cookie()`wp-includes/pluggable.php`	Validates authentication cookie.
get_userdata()`wp-includes/pluggable.php`	Retrieves user info by user ID.
get_profile()`wp-includes/deprecated.php`	Retrieve user data based on field.
WP_Query::get_queried_object()`wp-includes/class-wp-query.php`	Retrieves the currently queried object.
WP_Query::get_posts()`wp-includes/class-wp-query.php`	Retrieves an array of posts based on query variables.
check_password_reset_key()`wp-includes/user.php`	Retrieves a user row based on password reset key and login.
username_exists()`wp-includes/user.php`	Determines whether the given username exists.
email_exists()`wp-includes/user.php`	Determines whether the given email exists.
wp_authenticate_username_password()`wp-includes/user.php`	Authenticates a user, confirming the username and password are valid.
get_userdatabylogin()`wp-includes/pluggable-deprecated.php`	Retrieve user info by login name.
get_user_by_email()`wp-includes/pluggable-deprecated.php`	Retrieve user info by email.
wp_setcookie()`wp-includes/pluggable-deprecated.php`	Sets a cookie for a user who just logged in. This function is deprecated.
get_pages()`wp-includes/post.php`	Retrieves an array of pages (or hierarchical post type items).
is_user_spammy()`wp-includes/ms-functions.php`	Determines whether a user is marked as a spammer, based on user login.
wpmu_signup_blog_notification()`wp-includes/ms-functions.php`	Sends a confirmation request email to a user when they sign up for a new site. The new site will not become active until the confirmation link is clicked.
wpmu_signup_user_notification()`wp-includes/ms-functions.php`	Sends a confirmation request email to a user when they sign up for a new user account (without signing up for a site at the same time). The user account will not become active until the confirmation link is clicked.
is_site_admin()`wp-includes/ms-deprecated.php`	Determine if user is a site admin.
get_user_details()`wp-includes/ms-deprecated.php`	Deprecated functionality to retrieve user information.
get_user_id_from_string()`wp-includes/ms-deprecated.php`	Get a numeric user ID from either an email address or a login.
check_comment()`wp-includes/comment.php`	Checks whether a comment passes internal checks to be allowed to add.

Show 36 more Show less

Changelog

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

User Contributed Notes

Skip to note 8 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 20You must log in to vote on the helpfulness of this note
Sample response of
```
$author_obj = get_user_by('id', 1);
```
object(WP_User)#96 (7) { ["data"]=> object(stdClass)#95 (10) { ["ID"]=> string(1) "1" ["user_login"]=> string(10) "superadmin" ["user_pass"]=> string(34) "$P$Bx0Jgq6/Qw/o3A5fXcVKg4jxQr2PAB1" ["user_nicename"]=> string(10) "superadmin" ["user_email"]=> string(16) "[email protected]" ["user_url"]=> string(0) "" ["user_registered"]=> string(19) "2014-02-21 21:31:40" ["user_activation_key"]=> string(0) "" ["user_status"]=> string(1) "0" ["display_name"]=> string(10) "superadmin" } ["ID"]=> int(1) ["caps"]=> array(1) { ["administrator"]=> bool(true) } ["cap_key"]=> string(25) "wp_capabilities" ["roles"]=> array(1) { [0]=> string(13) "administrator" } ["allcaps"]=> array(63) { ["switch_themes"]=> bool(true) ["edit_themes"]=> bool(true) ["activate_plugins"]=> bool(true) ["edit_plugins"]=> bool(true) ["edit_users"]=> bool(true) ["edit_files"]=> bool(true) ["manage_options"]=> bool(true) ["moderate_comments"]=> bool(true) ["manage_categories"]=> bool(true) ["manage_links"]=> bool(true) ["upload_files"]=> bool(true) ["import"]=> bool(true) ["unfiltered_html"]=> bool(true) ["edit_posts"]=> bool(true) ["edit_others_posts"]=> bool(true) ["edit_published_posts"]=> bool(true) ["publish_posts"]=> bool(true) ["edit_pages"]=> bool(true) ["read"]=> bool(true) ["level_10"]=> bool(true) ["level_9"]=> bool(true) ["level_8"]=> bool(true) ["level_7"]=> bool(true) ["level_6"]=> bool(true) ["level_5"]=> bool(true) ["level_4"]=> bool(true) ["level_3"]=> bool(true) ["level_2"]=> bool(true) ["level_1"]=> bool(true) ["level_0"]=> bool(true) ["edit_others_pages"]=> bool(true) ["edit_published_pages"]=> bool(true) ["publish_pages"]=> bool(true) ["delete_pages"]=> bool(true) ["delete_others_pages"]=> bool(true) ["delete_published_pages"]=> bool(true) ["delete_posts"]=> bool(true) ["delete_others_posts"]=> bool(true) ["delete_published_posts"]=> bool(true) ["delete_private_posts"]=> bool(true) ["edit_private_posts"]=> bool(true) ["read_private_posts"]=> bool(true) ["delete_private_pages"]=> bool(true) ["edit_private_pages"]=> bool(true) ["read_private_pages"]=> bool(true) ["delete_users"]=> bool(true) ["create_users"]=> bool(true) ["unfiltered_upload"]=> bool(true) ["edit_dashboard"]=> bool(true) ["update_plugins"]=> bool(true) ["delete_plugins"]=> bool(true) ["install_plugins"]=> bool(true) ["update_themes"]=> bool(true) ["install_themes"]=> bool(true) ["update_core"]=> bool(true) ["list_users"]=> bool(true) ["remove_users"]=> bool(true) ["add_users"]=> bool(true) ["promote_users"]=> bool(true) ["edit_theme_options"]=> bool(true) ["delete_themes"]=> bool(true) ["export"]=> bool(true) ["administrator"]=> bool(true) } ["filter"]=> NULL }
Log in to add feedback
Skip to note 9 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 18You must log in to vote on the helpfulness of this note
Default usage
```
$user = get_user_by( 'email', '[email protected]' );
echo 'User is ' . $user->first_name . ' ' . $user->last_name;
```

get_user_by( string $field, int|string $value ): WP_User|false

In this article

Parameters

Return

Source

Changelog

User Contributed Notes

get_user_by( string $field, int|string $value ): WP_User|false

In this article

Parameters

Return

Source

Related

Changelog

User Contributed Notes