説明
パラメータ
- $network_idネットワークID(サイトID)を指定。
- $optionオプション名を指定。
- $defaultデフォルト値(オプションが保存されていない場合の値)を指定(省略時はfalse)。
返り値
ネットワークオプションの値を返す。注意
バージョン4.4.0で get_site_option関数の機能(フィルターを含む)を引き継いだ関数で、get_site_option関数はこの関数のラッパー関数となっている。バージョン4.4.0およびバージョン4.7.0で各フィルターのパラメータが追加されている。
本関数はマルチサイト向けで一般的なシングルサイトで使用された場合は get_option関数が呼び出される。
パラメータ$network_idがnullの場合は現在のネットワーク(サイト)が対象となる。
"pre_site_option_{$option}"フィルターの返り値がfalse以外の場合は、以降の処理は行われずその値がネットワークオプションの値となる。
[4.9.0]"pre_site_option_{$option}"フィルターにパラメータ$defaultが追加された。
使用例
- 現在のネットワークのオプション'myplugin_properties'の値を取得する。
<?php $val = get_network_option( null, 'myplugin_properties' ); ?>
- ネットワークIDが2のオプション'myplugin_properties'の値をデフォルト値を指定して取得する。
<?php $val = get_network_option( 2, 'myplugin_properties', $default_properties ); ?>
フィルター
[2.9.0]データベースに保存された値を取得する前に'pre_site_option_{$option}'フィルターを呼び出す。パラメータ$valueには省略時の値としてfalseが、$optionには本関数が受け取った同名の変数の値が、$network_idには本関数が受け取った同名の変数をint型でキャストした値が格納されている。[4.9.0]パラメータ$defaultが追加され、本関数が受け取った内容が格納されている。$pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id, $default );
return apply_filters( "default_site_option_{$option}", $default, $option, $network_id );
return apply_filters( "site_option_{$option}", $value, $option, $network_id );
アクション
実行するアクションはありません。ソースファイル
/wp-includes/option.php最終更新 : 2022年06月01日 16:24
関連
お勧め
投稿一覧ページに「更新日時」カラムを追加してみた(2019年8月27日 更新)
サイトの特性によるが、「投稿」には繰り返し更新するものがある。そんなサイトでは投稿一覧ページに「更新日時」があった方が便利。というわけで、今回は投稿一覧にソートに対応した「更新日時」カラムを追加する方法を紹介する。
連番のユーザーIDを回避できないか考えた(2019年6月4日 更新)
WordPressのユーザーIDは最初の管理者が1、次に追加したユーザーが2といった感じの連番になる。連番のIDはサイトによっては好ましくないケースがあり、連番を回避する方法がないか検討した。
Twenty Seventeenのフォントサイズを変更してみた(2021年12月15日 更新)
先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。
4.2.3でちょっと変わったショートコード(2018年5月27日 更新)
4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。
「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 更新)
投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。