add_network_option()


WordPressの関数add_network_option()は、ネットワーク（マルチサイト）のオプションを追加するために使用されます。この関数を利用すると、特定のネットワークコンテキストで設定を保存および管理することが可能です。

シンタックス

add_network_option( int $network_id, string $option_name, mixed $value );

引数の説明:

  • $network_id (int) — 対象のネットワークのID。
  • $option_name (string) — 保存するオプションの名前。
  • $value (mixed) — 保存する値。この値は文字列、配列、オブジェクトなど任意のデータ型を指定できます。

例1: ネットワークにオプションを追加

次のコードは、ネットワークID1に「example_option」というオプションを追加し、その値として「example_value」を設定します。

add_network_option( 1, 'example_option', 'example_value' );

例2: 動的にネットワークIDを取得してオプションを追加

ネットワークIDを動的に取得し、オプションを追加する例です。

add_network_option( get_current_network_id(), 'dynamic_option', array( 'key' => 'value' ) );

例3: 設定済みのオプション値を確認する

追加したオプションの値を取得して確認する例です。

$value = get_network_option( 1, 'example_option' );
echo $value;

例4: 条件に基づいてオプションを追加

指定したネットワークにオプションが存在しない場合に追加します。

if ( ! get_network_option( 1, 'conditional_option' ) ) {
    add_network_option( 1, 'conditional_option', 'conditional_value' );
}

例5: ネットワーク全体の設定を初期化

複数のオプションを追加する初期化スクリプトの例です。

$options = array(
    'option_one' => 'value_one',
    'option_two' => 'value_two'
);

foreach ( $options as $key => $value ) {
    add_network_option( get_current_network_id(), $key, $value );
}

注意点

  • $network_idが無効または存在しない場合、エラーが発生します。
  • 既存のオプション名と重複すると、データの上書きが行われません。新しい名前を指定してください。
  • マルチサイト機能が有効でない場合、この関数は使用できません。

関連機能：