説明
パラメータ
- $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
関連
お勧め
Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
さくらのVPSでKUSANAGI(2018年5月27日 更新)
請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。
ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。「Align widgets horizontally」プラグインのフィルター使用例(2024年5月15日 更新)
ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。
各投稿記事で設定されているカスタムフィールドの値を取得するには(2011年9月16日 更新)
投稿記事ごとに設定されているカスタムフィールドの値は get_post_meta関数で取得できるが、すべての投稿記事で設定されているカスタムフィールドの値を一覧を取得する関数が見当たらない。カテゴリーや投稿タグのようにそれぞれの値と実際に使用されている投稿記事件数を取得したいのだが、探し方が悪いのか見つからないのだ。