get_user_meta()


WordPress関数get_user_meta()は、特定ユーザーに関連付けられたメタデータを取得するために使用されます。

構文

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

引数の説明:

  • $user_id (int) — メタデータを取得する対象のユーザーID。
  • $key (string) — 取得するメタキー。指定しない場合、すべてのメタデータが返されます。
  • $single (bool) — trueを指定すると、単一の値を返します。falseの場合、配列を返します。

例1: 特定のメタデータを取得

以下のコードは、特定のキーのユーザーメタデータを取得します。

<?php $meta_value = get_user_meta( get_current_user_id(), 'example_key', true ); ?>

例2: すべてのユーザーメタを取得

次のコードは、特定のユーザーに関連付けられたすべてのメタデータを取得します。

<?php $all_meta = get_user_meta( get_current_user_id() ); ?>

例3: メタデータの存在確認

以下のコードは、特定のメタデータが存在するかどうかを確認します。

<?php
if ( get_user_meta( get_current_user_id(), 'example_key', true ) ) {
    echo 'メタデータが存在します。';
}
?>

例4: 配列形式で複数の値を取得

複数の値を配列で取得する方法は以下の通りです。

<?php $meta_values = get_user_meta( get_current_user_id(), 'example_key', false ); ?>

例5: 条件に基づいて処理を実行

特定のユーザーメタデータに基づいて条件分岐を行います。

<?php
if ( get_user_meta( get_current_user_id(), 'subscription_status', true ) === 'active' ) {
    echo 'アクティブなサブスクリプションがあります。';
} else {
    echo 'サブスクリプションはアクティブではありません。';
}
?>

注意事項

  • $user_idに無効な値を渡すとエラーが発生します。
  • $singleを適切に設定しない場合、期待する値形式が得られないことがあります。

関連機能：