add_site_meta()


WordPressのadd_site_meta()関数は、ネットワーク内のサイトにメタデータを追加するために使用されます。この関数はマルチサイト環境で動作し、特定のサイトに関連付けられたメタデータを保存します。

構文

add_site_meta( int $site_id, string $meta_key, mixed $meta_value, bool $unique = false );

引数の説明:

  • $site_id (int) — メタデータを追加するサイトのID
  • $meta_key (string) — メタデータのキー名
  • $meta_value (mixed) — 保存するメタデータの値
  • $unique (bool) — 同じキーのメタデータが既に存在する場合に上書きするかどうか

例1: サイトにシンプルなメタデータを追加

現在のサイトにメタデータを追加します。

add_site_meta(get_current_blog_id(), 'site_color', 'blue');

例2: ユニークなメタデータを追加

同じキーで複数の値が保存されないようにします。

add_site_meta(1, 'primary_contact', 'admin@example.com', true);

例3: 配列としてメタデータを保存

配列をメタデータとして保存します。

add_site_meta(2, 'site_settings', array('layout' => 'wide', 'footer' => 'simple'));

例4: 別サイトにメタデータを追加

特定のサイトIDを指定してメタデータを追加します。

add_site_meta(3, 'special_note', 'This is a premium site');

例5: 数値メタデータを追加

数値型のメタデータを保存します。

add_site_meta(get_current_blog_id(), 'visit_count', 100);

例6: ブール値のメタデータ

真偽値のメタデータを追加します。

add_site_meta(1, 'is_verified', true);

例7: シリアライズされたオブジェクトを保存

オブジェクトをメタデータとして保存します。

$data = new stdClass(); $data->status = 'active'; add_site_meta(2, 'site_status', $data);

注意点:

  • マルチサイト環境でのみ使用可能です
  • サイトIDが存在しない場合、falseを返します
  • メタデータのキー名は一意である必要があります

関連機能：