update_network_option

説明

bool update_network_option( int $network_id, string $option, mixed $value )
ネットワークオプション(サイトオプション)を更新する。

パラメータ

  • $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 );
[3.0.0]上記のアクション後に'update_site_option'アクションを呼び出す。パラメータ$optionおよび$valueには本関数が受け取った値が、$old_valueには更新前のオプションの値が、$network_idには本関数が受け取った同名の変数をint型でキャストした値が格納されている。
do_action( 'update_site_option', $option, $value, $old_value, $network_id );

ソースファイル

/wp-includes/option.php

最終更新 : 2022年06月01日 16:24



お勧め

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

5.7の新機能:HTTPからHTTPSへの移行(2021年3月13日 更新)

先週は「WordPress 5.7 Beta 2(以降Beta 2)」が公開され、正式版リリースへ一歩進みました。WordPress 5.7の注目ポイントの1つに「HTTPからHTTPSへの移行」を手助けする機能があり、それに関連する機能を含んだhttps-detection.phpファイルとhttps-migration.phpが追加されていた。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。