get_user_meta() の使い方|説明・引数・注意点

説明

get_user_meta() は、ユーザーのメタデータを取得する関数です。

基本構文

get_user_meta( int $user_id, string $key = '', bool $single = false ): mixed

引数

  • $user_id:ユーザーID
  • $key:メタキー
  • $single:単一の値で返すか

戻り値

メタの値。

使い方(サンプル)

echo esc_html( get_user_meta( 1, 'nickname', true ) );

注意点

  • $single を true にしないと配列で返ります。

実務での使いどころ

  • ユーザーごとの設定や、プロフィールの追加項目を取得するとき。
  • ログインユーザーの、独自の情報を取り出すとき。

よくあるミスと対処

  • 第3引数 $single を指定せず、配列が返ってくる。既定は false で、値は配列で返る。
  • $key を省略すると、すべてのメタが、配列の配列で返る。
  • 出力時に、エスケープしていない。

NG例

echo get_user_meta( $user_id, 'phone' ); // 「Array」と表示される

OK例

echo esc_html( get_user_meta( $user_id, 'phone', true ) );

使い分け早見表

関数 役割
get_user_meta() ユーザーのメタを取得する
update_user_meta() 値を保存する
delete_user_meta() 値を削除する

関連項目

update_user_meta()、get_post_meta()

公式リファレンス:get_user_meta() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました