add_blog_option()

add_blog_option() は、WordPress マルチサイト環境で特定のブログ（サイト）にオプションを追加するための関数です。

マルチサイト機能を使用している場合に、各サイトごとのカスタム設定を管理したいときに役立ちます。

通常の add_option() と異なり、ブログ（サイト）ごとに異なる値を設定できる点が特徴です。

機能の説明

add_blog_option() は、指定したブログ ID に対して新しいオプション（設定項目）を追加します。
この関数を使用することで、マルチサイト環境の各サイトに異なるオプション値を設定できます。

• マルチサイトの各サイトに独立した設定を保存する
• 管理者が各サイトごとに個別のオプションを設定できるようにする
• すでに存在するオプションを上書きしないようにする（オプションが存在しない場合のみ追加）

シンプルなコード例

ブログ ID 2 に custom_option というオプションを追加し、デフォルト値を hello world に設定する例です。

add_blog_option(2, 'custom_option', 'hello world');

使い方の説明

add_blog_option() の基本的な構文は以下の通りです。

add_blog_option($blog_id, $option_name, $value);

使用例

特定のブログ（サイト）に対してオプションを追加する場合の例です。

$blog_id = 3; // ブログ ID 3 に対して設定
$option_name = 'custom_setting';
$value = 'My custom value';

if (!get_blog_option($blog_id, $option_name)) {
    add_blog_option($blog_id, $option_name, $value);
}

このコードは、ブログ ID 3 に custom_setting というオプションがまだ存在しない場合に追加します。

一緒に使うことが多い関連タグ

get_blog_option()

get_blog_option() を使用すると、指定したブログ ID のオプションを取得できます。

$value = get_blog_option(2, 'custom_option');
echo $value; // "hello world"

update_blog_option()

既存のオプションを更新する場合は update_blog_option() を使用します。

update_blog_option(2, 'custom_option', 'new value');

delete_blog_option()

不要になったオプションを削除する場合は delete_blog_option() を使用します。

delete_blog_option(2, 'custom_option');

追加情報で取得したい場合

get_blog_option() を使用して現在のオプション値を確認

オプションの値を取得する際には、get_blog_option() を利用できます。

$option_value = get_blog_option(2, 'custom_option', 'デフォルト値');
echo $option_value;

この例では、custom_option の値が存在しない場合、デフォルト値 を返します。

get_option() との違い

add_option() は通常のシングルサイト環境で使用し、サイト全体で共通のオプションを追加しますが、
add_blog_option() はマルチサイト環境でブログ（サイト）ごとにオプションを追加できます。

// シングルサイト用（全体共通）
add_option('global_option', '全サイト共通の値');

// マルチサイト用（特定のサイトのみ）
add_blog_option(2, 'custom_option', 'サイトごとの値');

想定されるトラブル

add_blog_option() が機能しない

• WordPress がマルチサイトとして設定されているか確認する。
• add_blog_option() の前に switch_to_blog($blog_id) を使って適切なブログを切り替える。

switch_to_blog(2);
add_blog_option(2, 'custom_option', 'hello world');
restore_current_blog();

すでにオプションが存在するため追加されない

add_blog_option() は既存のオプションがあると追加されないため、代わりに update_blog_option() を使用する。

update_blog_option(2, 'custom_option', 'new value');

Q＆A

if (!get_blog_option(2, 'custom_option')) {
    add_blog_option(2, 'custom_option', 'default value');
}

$value = get_blog_option(2, 'custom_option');
add_blog_option(3, 'custom_option', $value);

まとめ

add_blog_option() は、WordPress のマルチサイト環境において、特定のブログ（サイト）にカスタムオプションを追加するための関数です。

get_blog_option() や update_blog_option() と組み合わせることで、各サイトごとのカスタマイズが容易になります。