get_network_option

（4.4.0以降）
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が追加された。

[6.9.0]'pre_site_option'フィルターが追加された。

使用例

  • 現在のネットワークのオプション'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 );
[6.9.0]"pre_site_option_{$option}"フィルターの返り値を判定する前に'pre_site_option'フィルターを呼び出す。パラメータ$preは"pre_site_option_{$option}"フィルターの返り値が、そのほかのパラメータは'pre_site_option_{$option}'フィルターと同じ内容が格納されている。 [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

最終更新 : 2025年12月04日 10:36

関連

参考

Code Reference: get_network_option

お勧め

5.5の機能強化：テンプレートパーツの取得関連（2020年8月12日 更新）

来月にリリースされるWordPress 5.5に向けてBeta 1～4と公開が続いている。「WordPress 5.5 Beta 4（以降Beta 4）」のソースコードを見ていくと、テンプレートパーツを取得する関数にパラメータが追加されていた。

ブロックエディターの文字サイズ設定を変えてみる（2019年12月12日 更新）

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

コメントの「ウェブサイト」止めました（2014年4月15日 更新）

とあるサイトのスパムコメントが多く、その都度のスパム指定するのが面倒である。これまでいくつか対策を行ってきたが、そういった対応にもいい加減うんざりしてきたので、試験的に「ウェブサイト」を無効化しようと思った。

WordPressのコーディングスタンダードとPSR-2がかみ合わない（2018年5月27日 更新）

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon（4.6）」から「Oxygen（4.7）」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style（Formatter）」が「PSR-2」に設定されていることが原因だった。

はじめてJSONファイル（JED 1.x）を作った時のメモ（2022年3月11日 更新）

先日、サイト間で投稿内容をコピー＆ペーストするためのプラグイン「Paste JSON text」をブロックエディターに対応させた。このプラグインでは、JavaScriptファイルで翻訳テキストを使用しており、はじめてJEDファイルを作成。その作業のポイントを忘れないように残すことにした。