• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/get userdata

提供: WordPress Codex 日本語版
移動先: 案内検索

渡された ID を持つユーザーに紐づく情報からなる WP_User オブジェクトを返します。プロパティはデータベースの wp_users および wp_usermeta テーブルに対応します(データベース概要 を参照)。

ユーザーが存在しなければ false を返します。

この関数は get_user_by( 'id', $userid ) のエイリアスです。

使い方

<?php get_userdata( $userid ); ?>

パラメータ

$userid
整数) (必須) 取得するユーザーの ID。
初期値: なし

戻り値

(真偽値|オブジェクト) 
失敗すると False、成功すると WP_User オブジェクト。

用例

基本の使い方

get_userdata() を呼び出すとユーザーデータのオブジェクトが返されます。ユーザー情報はメンバー変数として取り出すことができます。

一部を表示する例です:

<?php $user_info = get_userdata( 1 );
      echo 'ユーザー名: ' . $user_info->user_login . "\n";
      echo '役割: ' . implode( ', ', $user_info->roles ) . "\n";
      echo 'ユーザー ID: ' . $user_info->ID . "\n";
?>

結果はこうなります:

ユーザー名: admin
役割: administrator
ユーザー ID: 1

後で何度も表示できるように、特定の部分を変数へ入れることができます。

特定の部分を取り出す例です:

<?php $user_info = get_userdata( 1 );
      $username = $user_info->user_login;
      $first_name = $user_info->first_name;
      $last_name = $user_info->last_name;
      echo "$first_name $last_name さんは WordPress サイトへユーザー名 $username でログインできます。";
?>

結果はこうなります:

Harriet Smith さんは WordPress サイトへユーザー名 mrssmith でログインできます。

ユーザーのメタ情報にアクセスする

<?php $user_info = get_userdata( 1 );
      echo $user_info->last_name .  ", " . $user_info->first_name . "\n";
?>

結果はこうなります:

Doe, John


参考

次の値は wp_users および wp_usermeta テーブルの一部です。テーマやプラグインの中でこの関数を使ってアクセスできます。

wp_users

  • ID
  • user_login
  • user_pass
  • user_nicename
  • user_email
  • user_url
  • user_registered
  • display_name

wp_usermeta

  • first_name
  • last_name
  • nickname
  • description
  • wp_capabilities (配列)
  • admin_color (管理画面のテーマ。デフォルトは fresh。)
  • closedpostboxes_page
  • primary_blog
  • rich_editing
  • source_domain

なお、WP_User オブジェクトは一部のプロパティを提供するのに PHP 5 の「magic」メソッドを使います。例えば:
$user_info->user_login$user_info->data->user_login の短縮形で、
$user_info->rich_editingget_user_meta( $user_info->ID, 'rich_editing', true ) の短縮形です。


変更履歴

バージョン 0.71 : 新規導入

ソースファイル

get_userdata()wp-includes/pluggable.php にあります。


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function_Reference/get_userdata最新版との差分