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

お勧め

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