update_user_meta()


WordPressの関数update_user_meta()は、特定のユーザーに関連付けられたメタデータを追加または更新するために使用されます。

構文

update_user_meta( int $user_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' );

引数の説明:

  • $user_id (int) — メタデータを更新する対象ユーザーのID。
  • $meta_key (string) — 保存または更新するメタデータのキー。
  • $meta_value (mixed) — 保存または更新する値。
  • $prev_value (mixed) — 変更する前の値 (省略可能)。

例1: ユーザーのカスタムフィールドを追加

特定のユーザーに「department」というカスタムフィールドを追加する例です。

update_user_meta( get_current_user_id(), 'department', 'Marketing' );

例2: メタデータの値を更新

既存の「status」フィールドを「active」に更新するコードです。

update_user_meta( get_current_user_id(), 'status', 'active' );

例3: 条件付きで値を更新

指定した値が現在の値と一致する場合にのみ値を更新します。

update_user_meta( get_current_user_id(), 'status', 'inactive', 'active' );

例4: ユーザーのポイントを加算

現在の「points」値を取得して、10ポイント加算します。

$points = get_user_meta( get_current_user_id(), 'points', true );
update_user_meta( get_current_user_id(), 'points', $points + 10 );

例5: ユーザー情報を削除するための初期化

空の値を設定することで、特定のフィールドをリセットします。

update_user_meta( get_current_user_id(), 'department', '' );

注意事項

  • $meta_keyは一意である必要があります。他のプラグインやテーマとの競合を避けるため、プレフィックスを付けることを推奨します。
  • メタデータの保存には$user_idが必須です。無効なIDを指定するとエラーが発生します。
  • 不要なメタデータの増加を防ぐため、delete_user_meta()も検討してください。

関連機能：