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以外の場合は、以降の処理は行われずその値がネットワークオプションの値となる。

使用例

  • 現在のネットワークのオプション'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型でキャストした値が格納されている。
$pre = apply_filters( "pre_site_option_{$option}", $value, $option, $network_id );
[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

関連

お勧めコンテンツ

カスタムフィールド関連関数のおさらい(2012年6月22日 登録)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

Login rebuilderに「XML-RPC設定」を追加しました(2015年12月31日 登録)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

テーマから投稿画像のサイズを指定する(2012年3月15日 登録)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 登録)

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。

同じ名前のメタ情報をまとめて削除する(2014年3月21日 登録)

WordPressには、投稿情報、コメント情報、ユーザ情報のそれぞれを拡張できるメタ情報の仕組みが用意されている。投稿情報のメタ情報は「カスタムフィールド」として投稿画面に用意されているので投稿者自身が随時操作できるほか、テーマやプラグインからの操作も容易である。今回の中身はそんなメタ情報の一括削除の話だ。

最終更新日時 : 2017-03-23 12:02