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

最終更新 : 2022年06月01日 16:24



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

Login rebuilder 2.7.4の変更内容を紹介(2022年7月6日 更新)

Login rebuilder 2.7.4では、ダッシュボードの「ログインのログ」ウィジェット内に現在のユーザー(管理者のみ)のログイン状況を簡潔なメッセージで表示するようにした。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。

oEmbed対応サイトを整理した(2023年8月9日 更新)

投稿記事にTwitterやYouTubeのURL(アドレス)を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み(機能)はoEmbedというもので、対応サイトは随時バージョンアップしている。