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



お勧め

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

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

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

Google Mapsブロックを作る過程で悩んだ件(2022年8月23日 更新)

自分なりのGoogle Mapsブロックを作るべく、カスタムHTMLブロックをベースにいくつかのパラメータ要素をサイドバーに追加していく。Google Maps用のAPIキーについてはオプションデータ(wp_optionsテーブル)に格納して利用していこうと思ったのだが、その方法がさっぱりわからなかった。

Popoverコンポーネントのanchorプロパティについて考えたときのメモ(2024年8月19日 更新)

カスタムブロックやコアブロック向けのプラグインでお世話になるPopoverコンポーネント。表示位置を決定する上で大きく影響するのがanchorプロパティである。フィルターのコールバック関数で対象ブロックに干渉できない場合はどうしたらよいのだろうか。