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

最終更新 : 2021年06月02日 10:56

関連

参考

Code Reference: update_user_meta

お勧め

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日 更新）

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

管理画面の'アイキャッチ画像'を'写真'に変える（2013年1月23日 更新）

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

5.7の機能拡張：投稿一覧画面向けのフィルター（2021年2月18日 更新）

昨日、予定通り公開された「WordPress 5.7 Beta 3（以降Beta 3）」。WordPressはバージョンアップ毎にアクションやフィルターが追加されており、今回のバージョンアップでは投稿一覧画面に影響を与えるフィルターが追加されていた。

Login rebuilder 2.6.0の新機能紹介（2019年4月22日 更新）

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

タイトルのみをキーワード検索する（2014年4月3日 更新）

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。