概要
update_user_meta関数は、WordPressでユーザメタ情報を取得するために使用されます。この関数は、特定のユーザーに関連付けられたメタ情報を更新する機能を提供します。通常、ユーザーの追加情報を保存したり、カスタマイズしたりする際に役立ちます。具体的には、以下のようなシナリオで利用されます：
- ユーザーのプロフィール情報の更新
- ユーザーの設定やオプションの保存
- ユーザーのアクティビティログの記録
- ユーザーの権限や役割のカスタマイズ
- 会員制サイトでの会員情報の保存
- フォーラムやコメントシステムでのユーザー設定
- Eコマースサイトでの経歴や購入履歴の管理
- カスタムフィールドを使用したユーザー情報の保存
構文
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) : （オプション）以前の値。これが指定された場合、指定された値と一致している場合にのみ、メタ情報が更新されます。
戻り値
- 成功した場合は真 (true) 、失敗した場合は偽 (false) を返します。
関連する関数
使用可能なバージョン
update_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: ユーザープロフィールの更新
// ユーザーID 1 のプロフィールに新しい電話番号を追加
update_user_meta(1, 'phone_number', '123-456-7890');
このコードは、ユーザーID 1 に電話番号を追加または更新します。
サンプル2: ユーザー設定の保存
// ユーザーID 2 の通知設定を更新
update_user_meta(2, 'notification_settings', array('email' => true, 'sms' => false));
このサンプルは、ユーザーID 2 の通知設定を配列として保存します。
サンプル3: ユーザーのアクティビティログの記録
// ユーザーID 3 の最終ログイン時間を更新
update_user_meta(3, 'last_login', current_time('mysql'));
ここでは、ユーザーID 3 の最終ログイン時間を現在の時刻に更新しています。
サンプル4: ユーザーの役割のカスタマイズ
// ユーザーID 4 のカスタムユーザーロールを設定
update_user_meta(4, 'custom_user_role', 'premium_member');
このコードは、ユーザーID 4 にカスタムユーザーロールを追加または更新します。
サンプル5: Eコマースサイトでの購入履歴の保存
// ユーザーID 5 の購入履歴を更新
$purchase_history = array('order_1', 'order_2');
update_user_meta(5, 'purchase_history', $purchase_history);
このサンプルコードでは、ユーザーID 5 の購入履歴を配列として保存します。