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



お勧め

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

「Align widgets horizontally」プラグインのフィルター使用例(2024年5月15日 更新)

ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。

各投稿記事で設定されているカスタムフィールドの値を取得するには(2011年9月16日 更新)

投稿記事ごとに設定されているカスタムフィールドの値は get_post_meta関数で取得できるが、すべての投稿記事で設定されているカスタムフィールドの値を一覧を取得する関数が見当たらない。カテゴリーや投稿タグのようにそれぞれの値と実際に使用されている投稿記事件数を取得したいのだが、探し方が悪いのか見つからないのだ。