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

Parameters

$fieldstring

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

$valueint|string

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.

Uses · 2

• WP_User::get_data_by()Returns only the main user fields.
• WP_User::__construct()Constructor.

Used by · 43

• WP_Automatic_Updater::send_debug_email()Prepares and sends an email of a full log of background update results, useful for debugging and geekery.
• WP_Automatic_Updater::send_email()Sends an email upon the completion or failure of a background core update.
• WP_Automatic_Updater::send_plugin_theme_email()Sends an email upon the completion or failure of a plugin or theme background update.
• WP_Query::get_posts()Retrieves an array of posts based on query variables.
• WP_Query::get_queried_object()Retrieves the currently queried object.
• WP_REST_Templates_Controller::get_wp_templates_author_text_field()Returns a human readable text for the author of the template.
• WP_REST_Users_Controller::create_item()Creates a single user.
• WP_REST_Users_Controller::update_item()Updates a single user.
• _wp_personal_data_handle_actions()Handle list table actions.
• check_comment()Checks whether a comment passes internal checks to be allowed to add.
• check_password_reset_key()Retrieves a user row based on password reset key and login.
• email_exists()Determines whether the given email exists.

Source

View on Trac ↗View on GitHub ↗

101	function get_user_by( $field, $value ) {102		$userdata = WP_User::get_data_by( $field, $value );103 104		if ( ! $userdata ) {105			return false;106		}107 108		$user = new WP_User();109		$user->init( $userdata );110 111		return $user;112	}

History

Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/pluggable.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.