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関数を呼び出してオプション情報を更新している。

パラメータ$globalがfalseの場合、パラメータ$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



お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。(2024年11月13日 更新)

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア(Clear Unknown Formatting)」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群(2018年5月27日 更新)

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