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 - ユーザを登録する

参考

Code Reference: update_user_meta

お勧めコンテンツ

固定ページを投稿ページ用テンプレートファイル（single.php）で表示する（2013年7月31日 登録）

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

ホームディレクトリから過去のファイルを削除する（2013年1月27日 登録）

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

決まった値を返すだけの関数群（2015年7月15日 登録）

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

カスタムフィールド関連関数のおさらい（2012年6月22日 登録）

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

Somewhere search box：プラグイン作ってみました（2012年12月24日 登録）

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容（本文、カテゴリーや投稿タグ、カスタムフィールド）を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

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