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

お勧め

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つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。