add_user_meta

説明

int | false add_user_meta( int $user_id, string $meta_key, mixed $meta_value [ , bool $unique = false ] )
ユーザーメタ情報を追加する。

パラメータ

  • $user_id
    ユーザーIDを指定。
  • $meta_key
    メタ情報のキー名を指定。
  • $meta_key
    メタ情報の内容を指定。
  • $unique
    キー名のメタ情報が未登時のみ追加する場合はtrueを指定(省略時はfalse)。

返り値

メタ情報を追加した場合はメタ情報IDを返す。追加できなかった場合はfalseを返す。

注意

本関数は各パラメータを引き継いで add_metadata関数を呼び出し、その返り値を返している。


使用例

  • ユーザーメタ情報を追加する
    add_user_meta( $user_id, 'access', time() );
  • 未登録時のみユーザーメタ情報を追加する
    add_user_meta( $user_id, 'inactive', time(), true );

フィルター

直接実行するフィルターはありません。

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/user.php

最終更新 : 2024年06月25日 14:50



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。