Function Reference/get user by

This page redirects to an external site: https://developer.wordpress.org/reference/functions/get_user_by/

Languages: English • 日本語 한국어 • (Add your language)

1 Description
2 Usage
3 Parameters
4 Return Values
5 Examples
- 5.1 Default usage
6 Notes
7 Change Log
8 Source File
9 Related

Description

Get user data by field and data. The possible fields are shown below with the corresponding columns in the wp_users database table.

'id' - ID
'slug' - user_nicename
'email' - user_email
'login' - user_login

Usage

<?php $user = get_user_by( $field, $value ); ?>

Parameters

$field

(string) (required) 'id', 'slug', 'email', or 'login'

Default: None

$value

(string|integer) (required) Search for this field value

Default: None

Return Values

(mixed): WP_User object or false if no user is found. Will also return false if $field does not exist.

Examples

Default usage

$user = get_user_by( 'email', '[email protected]' );
echo 'User is ' . $user->first_name . ' ' . $user->last_name;

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
}

Notes

Uses WP_User::get_data_by().

Change Log

3.3.0 - This function now uses WP_User::get_data_by() instead of using wpdb directly.
Since: 2.8.0

Source File

get_user_by() is located in wp-includes/pluggable.php.

Get User Functions:

See also index of Function Reference and index of Template Tags.

Codex