説明
パラメータ
- $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
関連
お勧め
スマートフォン向けの振り分けを自前で行う(2012年1月23日 更新)
PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)
固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。
適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす(2019年5月24日 更新)
/wp-includes/template-loader.phpではリクエストされたページに応じて現在のテーマにあるテンプレートファイルの中から適切なものを選びに振り分けている。ここでは、さまざまなテンプレートファイルの種類と、テンプレートファイルが省略された場合の内部の動作についてまとめてみる。管理者ページに文言を表示する(2012年4月19日 更新)
お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。5.3の機能強化:ユーザーパスワードの表示と非表示(2019年9月30日 更新)
「WordPress 5.3 Beta 1」に記載されていた「Toggle password view」という項目。「Other Changes for Developers」の見出しの中ということもあり、ちょっと調べてみた。