update_site_meta()


WordPressのupdate_site_meta()関数は、ネットワーク内のサイト（ブログ）にメタデータを追加または更新するために使用されます。この関数はマルチサイト環境でのみ利用可能です。

構文

update_site_meta( int $site_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' );

引数の説明:

  • $site_id (int) — メタデータを更新するサイトのID
  • $meta_key (string) — メタデータのキー名
  • $meta_value (mixed) — 保存する値
  • $prev_value (mixed) — 以前の値（オプション）

例1: サイトメタデータの追加

新しいメタデータをサイトに追加します。

update_site_meta(get_current_blog_id(), 'custom_setting', 'value');

例2: 既存メタデータの更新

既存のメタデータを新しい値で更新します。

update_site_meta(2, 'custom_setting', 'new_value');

例3: 特定の値を持つメタデータの更新

以前の値が’old_value’の場合のみ更新します。

update_site_meta(3, 'custom_setting', 'updated_value', 'old_value');

例4: 配列データの保存

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

update_site_meta(get_current_blog_id(), 'site_options', array('color'=>'red','size'=>'large'));

例5: ブール値の保存

真偽値をメタデータとして保存します。

update_site_meta(5, 'is_featured', true);

例6: 数値の保存

数値をメタデータとして保存します。

update_site_meta(6, 'view_count', 1000);

例7: シリアライズされたデータの更新

シリアライズされたデータを更新します。

update_site_meta(7, 'serialized_data', maybe_serialize($complex_data));

注意点

  • この関数はマルチサイト環境でのみ動作します
  • サイトIDが存在しない場合、falseを返します
  • メタキーが空の文字列の場合、falseを返します

関連機能：