update_user_option

説明

int | bool update_user_option( int $user_id, string $option_name, mixed $newvalue [ , bool $global = false ] )
ユーザーオプション情報を更新する。

パラメータ

  • $user_id
    ユーザーIDを指定。
  • $option_name
    オプション名を指定。
  • $newvalue
    オプション値を指定。
  • $global
    マルチサイト時に全サイト共有にする場合はtrueを指定(省略時はfalse)。

返り値

オプションが未登録の場合は追加したユーザーメタ情報のIDを、更新できた場合はtrueを、更新できなかった場合はfalseを返す。

注意

本関数では update_user_meta関数を呼び出してオプション情報を更新している。

パラメータ$globalfalseの場合、パラメータ$option_nameの前にブログプレフィックス($wpdb->get_blog_prefix())が追加され、それが実際のオプション名となる。


使用例

  • 'plugin-option'という名前のオプション値を更新する。
    update_user_option( $user->ID, 'plugin-option', $value );

フィルター

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

アクション

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

ソースファイル

/wp-includes/user.php

最終更新 : 2022年01月31日 13:04



お勧め

CSSやJavaScriptファイルのバージョン番号を変える(2018年5月27日 更新)

WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。

テーブルブロックを投稿メタ(カスタムフィールド)に保存する(2022年1月5日 更新)

ふと「テーブルブロックの内容を投稿メタ(カスタムフィールド)として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。

カスタム投稿タイプの投稿保存には専用アクションを使おう(2014年7月4日 更新)

カスタム投稿タイプを登録して、専用ウィジェット(meta_box)を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)

この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。