WordPress at a glance

get_user_by() WP 1.0

Retrieve user info by a given field

Notes:

  • Since 4.4.0 Added 'ID' as an alias of 'id' for the $field parameter.

This is a pluggable function, and it can be replaced from plugin. It means that this function is defined (works) only after all plugins are connected (included), but before this moment the function has not yet been defined... Therefore, you cannot call this and all functions depended on this function directly from a plugin code. It must be called via hook plugins_loaded or later, for example on hook init.

Function replacement (override) — in a plugin you can create a function with the same name, then it will replace this function.

Works based on: WP_User()
✈ 1 time = 0.001296s = very slow | 50000 times = 3.27s = fast

No Hooks.

Return

WP_User/false. WP_User object on success, false on failure.

Usage

get_user_by( $field, $value );
$field(string) (required)
The field to retrieve the user with. id | ID | slug | email | login.
$value(int/string) (required)
A value for $field. A user ID, slug, email address, or login name.

Code of get_user_by: wp-includes/pluggable.php VER 4.9.8

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

Related Functions

From tag: Users (_user)

More from category: Other

No comments
    Hello, !     Log In . Register