get_network_option

説明

mixed get_network_option( int $network_id, string $option [ , mixed $default = false ] )
ネットワークオプション(サイトオプション)を取得する。

パラメータ

  • $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 );
[3.4.0]ネットワークオプションが未登録の場合は'default_site_option_{$option}'フィルターを呼び出す。パラメータ$defaultおよび$optionには本関数が受け取った値が、$network_idには本関数が受け取った同名の変数をint型でキャストした値が格納されている。
return apply_filters( "default_site_option_{$option}", $default, $option, $network_id );
[2.9.0]オプションの値を返す前に'site_option_{$option}'フィルターを呼び出す。パラメータ$valueには取得したオプションの値が、$optionには本関数が受け取った値が、$network_idには本関数が受け取った同名の変数をint型でキャストした値が格納されている。
return apply_filters( "site_option_{$option}", $value, $option, $network_id );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/option.php

最終更新 : 2019年02月25日 10:23



お勧め

ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)

管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。

headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。
<meta name="generator" content="WordPress 3.0.5" />

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。