概要
get_site_option関数は、WordPressのマルチサイト機能において、サイトオプションの値を取得するために使用される関数です。この関数は、特に複数のサイトを管理する際に便利で、サイトごとの設定情報を参照する場合に頻繁に利用されます。以下は、get_site_option関数がよく使われる機能の例です：
- サイト全体の設定やオプションを取得する
- マルチサイト環境でのプラグイン設定の管理
- ユーザー権限やロールの設定を取得する
- サイトのテーマ設定を適用する
- 特定のサイトに関連するカスタムオプションの読み込み
- サイトに関連する統計情報の取得
- オプションページの設定値を読み込む
- サイトのテンプレートファイルでのオプションのカスタマイズ
構文
get_site_option( string $option, mixed $default = false, int $blog_id = 0 )
パラメータ
$option(string): 取得したいオプションの名前$default(mixed, optional): オプションが存在しない場合に返されるデフォルト値 (デフォルトは false)$blog_id(int, optional): 特定のサイトのID。デフォルトは 0（現在のサイト）
戻り値
指定されたオプションの値。オプションが存在しない場合は、$defaultで指定された値が返されます。
関連する関数
この関数を使用可能なバージョン
get_site_optionは、WordPressバージョン 3.0 以降で利用可能です。
ワードプレスのコアファイルのパス
get_site_option関数は、wp-includes/options.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 |
非推奨または削除されたバージョン
現時点で、get_site_option関数は非推奨または削除されたバージョンはありません。
サンプルコード
サンプル1: サイトオプションの取得
$site_option = get_site_option('my_custom_option');
このコードは、my_custom_optionという名前のサイトオプションの値を取得し、変数$site_optionに格納します。
サンプル2: デフォルト値の指定
$site_option = get_site_option('non_existent_option', 'default_value');
このコードは、オプションが存在しない場合に'default_value'が返されるようにしています。
サンプル3: 特定のサイトのオプション取得
$site_option = get_site_option('site_theme', false, 2);
このコードは、サイトIDが2のサイトのsite_themeオプションを取得します。
サンプル4: プラグインの設定取得
$plugin_setting = get_site_option('my_plugin_setting', array());
このコードは、my_plugin_settingオプションの設定を取得し、存在しない場合は空の配列を返します。
サンプル5: サイト統計情報の取得
$site_views = get_site_option('site_views', 0);
このコードは、サイトの表示回数を取得し、設定されていない場合は0を返します。