get_site_option()


WordPressのget_site_option()関数は、ネットワーク全体のオプション値を取得するために使用されます。この関数は、マルチサイト環境で特に有用で、特定のサイトではなくネットワーク全体の設定を取得します。

構文

get_site_option( string $option, mixed $default = false, bool $use_cache = true );

引数の説明:

  • $option(string) — 取得したいオプションの名前。
  • $default(mixed) — オプションが存在しない場合に返されるデフォルト値。
  • $use_cache(bool) — キャッシュを使用するかどうか。デフォルトはtrue。

例1: 基本的な使用法

この例では、ネットワーク全体のオプション値を取得します。

$site_option_value = get_site_option('site_option_name');

例2: デフォルト値の指定

オプションが存在しない場合にデフォルト値を返す例です。

$site_option_value = get_site_option('site_option_name', 'default_value');

例3: キャッシュを使用しない

キャッシュを使用せずにオプション値を取得する例です。

$site_option_value = get_site_option('site_option_name', false, false);

例4: オプションの存在チェック

オプションが存在するかどうかをチェックする例です。

if (false !== get_site_option('site_option_name')) { echo 'オプションが存在します。'; }

例5: オプション値を配列として取得

オプション値を配列として取得する例です。

$site_option_array = get_site_option('site_option_name', array());

例6: オプション値をJSONとしてデコード

オプション値をJSON形式で保存し、デコードして使用する例です。

$site_option_json = get_site_option('site_option_name'); $decoded_value = json_decode($site_option_json);

例7: オプション値をシリアライズして保存

オプション値をシリアライズして保存し、取得時にアンシリアライズする例です。

$serialized_value = serialize(array('key' => 'value')); update_site_option('site_option_name', $serialized_value); $unserialized_value = unserialize(get_site_option('site_option_name'));

例8: オプション値を条件付きで更新

オプション値が特定の条件を満たす場合にのみ更新する例です。

if (get_site_option('site_option_name') === 'old_value') { update_site_option('site_option_name', 'new_value'); }

注意点

  • この関数はマルチサイト環境でのみ使用されます。シングルサイト環境ではget_option()を使用してください。
  • オプション名は一意である必要があります。他のプラグインやテーマとの競合を避けるため、プレフィックスを使用することを推奨します。
  • キャッシュを使用するとパフォーマンスが向上しますが、リアルタイムのデータが必要な場合はキャッシュを無効にしてください。

関連機能：