概要
get_network_option 関数は、WordPress のマルチサイト機能を使用している際に、ネットワークオプションを取得するために使用されます。この関数は、サイト全体の設定やオプションを取得する際に頻繁に利用されます。例えば、ネットワーク全体のメールアドレスやサイトの設定値などの取得に役立ちます。以下は、get_network_option 関数がよく使われる場面です。
- マルチサイトの基本設定の取得
- ネットワーク管理者向けのオプションの取得
- プラグインやテーマの設定値の確認
- 運営する複数サイト間の共有データの取得
- ネットワーク全体でのユーザー権限設定の確認
- 訪問者向けの設定値の取得
- 定期的なメンテナンス情報の取得
- マルチサイト間のデータ同期処理の実装
構文
get_network_option( int $network_id, string $option, mixed $default = false );
パラメータ
$network_id(int): ネットワークの ID。デフォルトのネットワークは 1。$option(string): 取得したいオプションの名前。$default(mixed): オプションが存在しない場合に返すデフォルト値（省略可能）。
戻り値
- オプションの値。指定されたオプションが存在しない場合は、デフォルト値が返される。
関連する関数
使用可能なバージョン
get_network_option 関数は、WordPress 3.0 以降で使用可能です。
コアファイルのパス
wp-includes/ms-functions.php
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | 〇 |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
get_network_option 関数は特定のワードプレスバージョンで非推奨または削除されたことはありません。