add_user_meta()


WordPressのadd_user_meta()関数は、特定のユーザーにメタデータを追加するために使用されます。

構文

add_user_meta( int $user_id, string $meta_key, mixed $meta_value, bool $unique = false );

引数の説明:

  • $user_id(int) — メタデータを追加するユーザーのID。
  • $meta_key(string) — 追加するメタデータのキー。
  • $meta_value(mixed) — 追加するメタデータの値。
  • $unique(bool) — 同じキーのメタデータが既に存在する場合に上書きするかどうか。デフォルトはfalse。

例1: ユーザーにメタデータを追加

この例では、IDが1のユーザーに「好きな色」というメタデータを追加します。

add_user_meta( 1, '好きな色', '青' );

例2: 一意のメタデータを追加

この例では、同じキーのメタデータが存在しない場合にのみ追加します。

add_user_meta( 1, '好きな色', '青', true );

例3: 現在のユーザーにメタデータを追加

現在ログインしているユーザーにメタデータを追加します。

add_user_meta( get_current_user_id(), '好きな色', '赤' );

例4: 配列をメタデータとして追加

メタデータの値として配列を使用します。

add_user_meta( 1, '趣味', array( '読書', '旅行', '料理' ) );

例5: 数値をメタデータとして追加

メタデータの値として数値を使用します。

add_user_meta( 1, '年齢', 30 );

例6: ブール値をメタデータとして追加

メタデータの値としてブール値を使用します。

add_user_meta( 1, '会員ステータス', true );

例7: 既存のメタデータを上書き

既存のメタデータを上書きする例です。

add_user_meta( 1, '好きな色', '緑', false );

例8: 複数のメタデータを追加

複数のメタデータを一度に追加します。

add_user_meta( 1, '好きな色', '青' ); add_user_meta( 1, '年齢', 25 ); add_user_meta( 1, '趣味', 'スポーツ' );

注意点

  • メタデータのキーは一意である必要はありませんが、$uniqueをtrueに設定すると、同じキーのメタデータが存在する場合に追加されません。
  • メタデータの値はシリアライズ可能なデータ型である必要があります。
  • ユーザーIDが存在しない場合、関数はfalseを返します。

関連機能：