get_current_blog_id() の使い方|説明・引数・注意点

説明

get_current_blog_id() は、現在のサイトのIDを取得する関数です。マルチサイトで使います。

基本構文

get_current_blog_id(): int

引数

引数はありません。

戻り値

サイトのID(整数)。マルチサイトでない環境では 1。

使い方(サンプル)

$site_id = get_current_blog_id();
$key     = 'my_cache_' . $site_id;

注意点

  • switch_to_blog() で切り替えたあとは、切り替え先のサイトのIDを返す。
  • マルチサイトでない環境では、1 を返す。

実務での使いどころ

  • サイトごとに、設定やキャッシュのキーを分けるとき。
  • switch_to_blog() の前後で、現在のサイトを確認するとき。

よくあるミスと対処

  • サイトのIDと、ネットワークのIDを取り違える。
  • switch_to_blog() のあとに呼び、切り替え先のIDになることを忘れる。

NG例

$key = 'my_cache'; // ネットワーク共通の場所に保存すると、サイトごとに分かれず、混ざる

OK例

$key = 'my_cache_' . get_current_blog_id();

使い分け早見表

関数 取得・実行するもの
get_current_blog_id() 現在のサイトのID
switch_to_blog() 別のサイトへ切り替える
is_main_site() メインサイトか判定する

関連項目

switch_to_blog()、restore_current_blog()、is_multisite()

公式リファレンス:get_current_blog_id() | WordPress Developer Resources

コメント

タイトルとURLをコピーしました