説明
update_site_option() は、マルチサイト全体で共有するオプションを更新する関数です。
基本構文
update_site_option( string $option, mixed $value ): bool引数
$option：オプション名$value：値
戻り値
更新できたら true。
使い方（サンプル）
update_site_option( 'my_network_setting', 'on' );注意点
- シングルサイトでは
update_option()と同じ動作になります。
実務での使いどころ
- マルチサイトで、ネットワーク全体の設定を保存するとき。
よくあるミスと対処
- ネットワーク全体の設定なのに、
update_option()を使っている。サイトごとの値になる。 - 戻り値が
falseのとき、失敗したと考える。値が変わらないときもfalseが返る。
NG例
update_option( 'my_network_setting', $value ); // 現在のサイトだけに保存されるOK例
update_site_option( 'my_network_setting', $value );使い分け早見表
| 関数 | 対象 |
|---|---|
update_site_option() |
ネットワーク全体（マルチサイト） |
update_option() |
現在のサイト |
get_site_option() |
ネットワーク全体の値を取得する |
関連項目
get_site_option()、update_option()
公式リファレンス：update_site_option() | Function | WordPress Developer Resources
コメント