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



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

Login rebuilder 2.7.4の変更内容を紹介(2022年7月6日 更新)

Login rebuilder 2.7.4では、ダッシュボードの「ログインのログ」ウィジェット内に現在のユーザー(管理者のみ)のログイン状況を簡潔なメッセージで表示するようにした。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。

oEmbed対応サイトを整理した(2023年8月9日 更新)

投稿記事にTwitterやYouTubeのURL(アドレス)を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み(機能)はoEmbedというもので、対応サイトは随時バージョンアップしている。