get_user_option

説明

mixed get_user_option( string $option [ , int $user = 0 [ , mixed $deprecated = '' ] ] )
ユーザオプション(プロフィール)情報を取得する。

パラメータ

  • $option
    オプション名を指定。
  • $user
    ユーザIDを指定(省略時は0)。
  • $deprecated
    3.0でdeprecatedに(使用は推奨されない)。

返り値

パラメータ$optionに応じた設定値を返す。オプション名が無効な場合はfalseを返す。

注意

パラメータ$userを省略した場合は、 wp_get_current_user関数を使って現在のユーザが適用される。

マルチサイトの場合、ユーザオプション情報はサイト(ブログ)固有と全サイト共有のものを保持できる。本関数で取得する場合、サイト固有のものかあるか調べ、ない場合に全サイト共有のものがないか調べる。


使用例

  • 現在のユーザの「ビジュアルリッチエディターを使用しない」がチェックされているか取得する。
    <?php $option = get_user_option( 'rich_editing' ); >
  • ユーザIDが3の「ブログ上の表示名」を取得する。
    <?php $name = get_user_option( 'display_name', 3 ); >

フィルター

[2.5.0]オプション情報を返す前に"get_user_option_{$option}"フィルターを呼び出す。パラメータ$resultにはオプション情報が、$optionには本関数が受け取った内容が、$userにはユーザ情報(WP_Userオブジェクト)が格納されている。
return apply_filters( "get_user_option_{$option}", $result, $option, $user );

アクション

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

ソースファイル

/wp-includes/user.php

最終更新 : 2021年06月02日 10:56



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。