説明
パラメータ
- $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
関連
お勧め
meta_compare_key使ってみた(2019年3月19日 更新)
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。
WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)
今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。
テーマから投稿画像のサイズを指定する(2012年3月15日 更新)
投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。ログインページを変える(2014年9月12日 更新)
WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)
ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。