説明
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
関連
お勧め
ブロックエディターの色設定を変えてみる(2019年12月11日 更新)
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
「姓」の後に「名」を(2013年11月6日 更新)
WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。
ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)
今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。
投稿情報を連想配列で参照する(2018年5月27日 更新)
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。