説明
パラメータ
- $network_idネットワークID(サイトID)を指定。
- $optionオプション名を指定。
- $valueオプション値を指定。
返り値
ネットワークオプションを更新した場合はtrueを、更新しなかった場合はfalseを返す。注意
バージョン4.4.0で update_site_option関数の機能(フィルターを含む)を引き継いだ関数で、update_site_option関数はこの関数のラッパー関数となっている。バージョン4.4.0およびバージョン4.7.0で各フィルター・アクションのパラメータが追加されている。
本関数はマルチサイト向けで一般的なシングルサイトで使用された場合は update_option関数が呼び出される。
パラメータ$network_idがnullの場合は現在のネットワーク(サイト)が対象となる。
'pre_update_site_option__{$option}'フィルターの返り値が更新前の値と同じ場合は、以降の処理は行われずfalseを返す。
使用例
- 現在のネットワークのオプション'myplugin_properties'の値を更新する。
<?php update_network_option( null, 'myplugin_properties' ); ?>
- ネットワークIDが2のオプション'myplugin_properties'の値を更新する。
<?php update_network_option( 2, 'myplugin_properties', $new_properties ); ?>
フィルター
[2.9.0]更新の前段階で現在のオプション値を取得しておりその直後に'pre_update_site_option_{$option}'フィルターを呼び出す。パラメータ$valueには本関数が受け取った値が、$old_valueには現在のオプション値が、$optionには本関数が受け取った同名の変数の値が、$network_idには本関数が受け取った同名の変数をint型でキャストした値が格納されている。$value = apply_filters( "pre_update_site_option_{$option}", $value, $old_value, $option, $network_id );
アクション
[2.9.0]オプション値を更新した場合に'update_site_option_{$option}'アクションを呼び出す。パラメータ$optionおよび$valueには本関数が受け取った値が、$old_valueには更新前のオプションの値が、$network_idには本関数が受け取った同名の変数をint型でキャストした値が格納されている。do_action( "update_site_option_{$option}", $option, $value, $old_value, $network_id );
do_action( 'update_site_option', $option, $value, $old_value, $network_id );
ソースファイル
/wp-includes/option.php最終更新 : 2022年06月01日 16:24
関連
お勧め
Login rebuilder 2.3.0の新機能を紹介(2018年5月27日 更新)
プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。
古めのリビジョンを削除した時のメモ(2022年5月16日 更新)
大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。
決まった値を返すだけの関数群(2018年5月27日 更新)
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
「Align widgets horizontally」プラグインのフィルター使用例(2024年5月15日 更新)
ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。
WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)
WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。