get_user_option

（2.0.0以降）
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

関連

参考

Code Reference: get_user_option

お勧め

時代はWP_Queryなのか（2011年8月1日 更新）

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

3.6リリース直前チェック（2013年7月26日 更新）

$wpdbは、WordPressのデータベースにアクセスする際に使用できる便利なオブジェクト。独自テーブルの利用やデータ検索の最適化など、標準提供される関数では実現できないことを手助けしてくれる。そんな$wpdbのescapeメソッドが3.6で非推奨（deprecated）になる。

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

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

さくらのVPSでKUSANAGI（2018年5月27日 更新）

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

投稿画面のウェジェットを2列にする（2013年4月17日 更新）

ダッシュボード画面ではスクリーンレイアウトを最大4列まで選択できるのに、投稿画面は1列か2列のどちらか。高解像度のディスプレイを使っていると、投稿画面では大画面のメリットを生かせていない理由がここにあるのではと感じ、3列対応にしてみた。