update_user_meta

(3.0.0以降)
update_user_meta - ユーザメタ情報を取得する

説明

bool update_user_meta( int $user_id, string $meta_key, mixed $meta_value [ , mixed $prev_value = '' ] )
ユーザメタ情報(拡張情報)を更新する。

パラメータ

  • $user_id
    ユーザIDを指定。
  • $meta_key
    メタ情報の名前を指定。
  • $meta_value
    メタ情報の値を指定。
  • $prev_value
    更新前の値を指定(省略時は'')。

返り値

メタ情報を更新した場合はtrue、更新できなかった場合はfalseを返す。

注意

パラメータ$meta_keyで指定したメタ情報が存在しない場合はそのメタ情報を追加する。
パラメータ$prev_valueを指定すると、メタ情報の名前と値のペアでメタ情報を検索し、それに一致した場合のみ更新する。

使用例

  • 名前'addr1'の値を、'Kanagawa'に変更する。
    <?php update_user_meta( $user->ID , 'addr1' , 'Kanagawa' ); ?>
  • 名前'addr1'で値が'Tokyo'の値を、'Kanagawa'に変更する。
    <?php update_user_meta( $user->ID , 'addr1' , 'Kanagawa', 'Tokyo' ); ?>

フィルター

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

アクション

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

ソースファイル

/wp-includes/user.php

関連

  • get_users - ユーザー情報を取得する
  • get_user_by - ユーザ情報の一部を指定し、マッチするユーザ情報を取得する
  • get_user_meta - ユーザメタ情報を取得する
  • wp_insert_user - ユーザを登録する

お勧めコンテンツ

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 登録)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

RSSフィードの抜粋をさらに抜粋(2011年7月21日 登録)

RSSフィードはデフォルトでは「全文(HTMLタグを含む)」になっているが、管理画面の「表示設定」では「抜粋のみ(HTMLタグは除外)」を選択できる。それでも投稿記事が長いと、その抜粋テキストも長くなってしまう。ここではそんなRSSフィードの抜粋テキストを調整する方法を紹介する。

WordPressの鼓動(2013年10月1日 登録)

WordPressでは、Ajaxを利用する方法の1つとしてadd_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。

「姓」の後に「名」を(2013年11月6日 登録)

WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 登録)

WordPress 3.5で登場するであろうWP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

最終更新日時 : 2013-05-07 13:13