概要
get_user_option 関数は、特定のユーザーのプロファイル情報を取得するために使用されるWordPressの関数です。主に以下のようなシナリオで利用されることが一般的です。
- ユーザーのダッシュボード設定を取得する
- 特定のユーザー関連のオプションを表示する
- フロントエンドでのユーザー固有のデータを表示する
- ユーザープロフィールのカスタムフィールドを取得する
- ユーザー毎の設定によるコンテンツの表示を制御する
- プラグイン設定に基づくユーザーインターフェイスを構築する
- ユーザーのダッシュボードのカスタマイズをサポートする
- ユーザーの好みに基づく機能を提供する
構文
get_user_option($option, $user_id);
パラメータ
- $option (string) – 取得したいユーザーオプションの名前。
- $user_id (int) – オプションを取得するユーザーのID。省略した場合は現在のユーザーが使用されます。
戻り値
- （mixed）指定されたユーザーオプションの値。オプションが存在しない場合は
falseを返します。
関連する関数
使用可能なバージョン
- WordPress 2.0.0 以降から使用可能です。
コアファイルのパス
wp-includes/user.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | 〇 |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
サンプルコード 1: ユーザーオプションを取得する
$user_id = get_current_user_id();
$color_scheme = get_user_option('color_scheme', $user_id);
echo 'ユーザーの色設定: ' . esc_html($color_scheme);
このコードは、現在のユーザーのカラースキーム設定を取得し、表示します。
サンプルコード 2: デフォルトのユーザーオプションを取得する
$default_layout = get_user_option('default_layout');
if ($default_layout) {
echo 'デフォルトのレイアウト: ' . esc_html($default_layout);
} else {
echo 'デフォルトレイアウトは設定されていません。';
}
このコードは、ユーザーのデフォルトレイアウト設定を取得し、存在しない場合はメッセージを表示します。
サンプルコード 3: 特定ユーザーのオプションを取得する
$other_user_id = 5;
$homepage_setting = get_user_option('homepage', $other_user_id);
echo 'ユーザー5のホームページ設定: ' . esc_html($homepage_setting);
このコードでは、ユーザーIDが5のユーザーのホームページ設定を取得して表示します。
サンプルコード 4: ユーザーのダッシュボード設定を反映する
$user_id = get_current_user_id();
$dashboard_widgets = get_user_option('dashboard_widgets', $user_id);
print_r($dashboard_widgets);
このコードは、ユーザーのダッシュボードウィジェット設定を取得し、配列として表示します。
サンプルコード 5: 設定が無い場合の処理
$user_id = get_current_user_id();
$custom_setting = get_user_option('custom_setting', $user_id);
if (!$custom_setting) {
echo 'カスタム設定は存在しません。デフォルトを使用します。';
}
このコードは、ユーザーのカスタム設定を取得し、存在しない場合にはデフォルト設定を使う旨のメッセージを表示します。