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



お勧め

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

Emojin:プラグイン作ってみました(2015年3月21日 更新)

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

メタボックスをクラシックエディターのみで表示する(2019年1月15日 更新)

投稿画面向けにメタボックスを使ったプラグインがあり、それがブロックエディターで意図した通りに機能しなかった。この対処方法を考える過程でエディタータイプに応じてメタボックスを出し分けできる方法が見つかったので紹介したい。