概要
get_user_meta関数は、特定のユーザーに関連付けられているメタデータを取得するために使用されます。この関数は、ユーザーのプロファイル情報やカスタムデータの保存と取得に頻繁に使われ、次のようなシナリオで特によく利用されます：
- ユーザーのプロフィール情報（名前、住所、電話番号など）を表示する。
- ユーザーの役割に基づいて異なる情報を表示する。
- ユーザーの設定や好み（言語選択やテーマの設定など）を取得する。
- 参加イベントや登録情報を管理する。
- ユーザーの投稿やコメント履歴からの統計データを取得する。
- アカウントの状態や特権（プレミアムメンバーシップなど）を管理する。
- ユーザーのフィードバックやクエスト入力を保存する。
- ソーシャルメディアアカウントとの連携情報を管理する。
構文
get_user_meta( int $user_id, string $key = '', bool $single = false )
パラメータ
$user_id(int): メタデータを取得する対象となるユーザーのID。$key(string): 取得するメタデータのキー。デフォルトは空文字列。$single(bool):trueに設定した場合、1つの値を返します。falseの場合は、該当する値の配列を返します。デフォルトはfalse。
戻り値
指定されたユーザーのメタデータの値。キーが存在しない場合はfalse。$singleパラメーターがtrueの場合は、単一の値（またはemptyの場合はfalse）を返します。
関連する関数
使用可能なバージョン
get_user_metaは、WordPressのバージョン2.0.0以降で利用可能です。
コアファイルのパス
wp-includes/user.php
この関数のアクションでの使用可能性
| アクション名 | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head |
非推奨または削除されたバージョン
この関数は、特定のバージョンで非推奨または削除されたことはありません。
サンプルコード
サンプルコード 1
$user_id = 1;
$user_bio = get_user_meta($user_id, 'description', true);
echo $user_bio;
このコードは、ユーザーIDが1のユーザーの自己紹介文を取得して表示します。
サンプルコード 2
$user_id = get_current_user_id();
$user_meta = get_user_meta($user_id);
print_r($user_meta);
このコードは、現在のユーザーのすべてのメタデータを配列形式で取得して表示します。
サンプルコード 3
$user_id = 2;
$user_preferences = get_user_meta($user_id, 'preferences', false);
if (!empty($user_preferences)) {
// ユーザーの好みを利用する
foreach ($user_preferences as $preference) {
echo $preference;
}
}
このコードは、ユーザーIDが2のユーザーが持つすべての「preferences」メタデータを取得し、それらの好みを出力します。
サンプルコード 4
$user_id = 3;
$last_login = get_user_meta($user_id, 'last_login', true);
if ($last_login) {
echo "最終ログイン: " . date("Y-m-d H:i:s", $last_login);
}
このコードは、ユーザーIDが3のユーザーの最終ログイン時間を取得し、フォーマットして表示します。
サンプルコード 5
$user_id = 4;
$custom_field = get_user_meta($user_id, 'favorite_color', true);
echo "お気に入りの色: " . $custom_field;
このコードは、ユーザーIDが4のユーザーのお気に入りの色を取得して表示します。