get_site_option() の使い方|説明・引数・注意点

説明

get_site_option() は、マルチサイト全体(ネットワーク)で共有するオプションを取得する関数です。

基本構文

get_site_option( string $option, mixed $default_value = false, bool $deprecated = true ): mixed

引数

  • $option:オプション名
  • $default_value:存在しないときの値

戻り値

保存されている値。

使い方(サンプル)

$limit = get_site_option( 'upload_space_check_disabled' );

注意点

  • シングルサイトでは get_option() と同じ動作になります。

実務での使いどころ

  • マルチサイトで、ネットワーク全体の設定を取得するとき。
  • 全サイト共通の設定値を、1か所に保存するとき。

よくあるミスと対処

  • ネットワーク全体の設定なのに、get_option() を使っている。サイトごとの値になる。
  • マルチサイトでない環境では、get_option() と同じ動作になることを知らない。
  • 保存されていないと false が返る。代わりの値は、第2引数で指定する。

NG例

$value = get_option( 'my_network_setting' ); // サイトごとの値になる

OK例

$value = get_site_option( 'my_network_setting', 'default' );

使い分け早見表

関数 対象
get_site_option() ネットワーク全体(マルチサイト)
get_option() 現在のサイト
update_site_option() ネットワーク全体に保存する

関連項目

update_site_option()、get_option()

公式リファレンス:get_site_option() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました