switch_to_blog

パラメータ

• $new_blog
  切り替えるブログIDを指定。
• $deprecated
  非推奨（使用しないこと）。

返り値

注意

マルチサイトにおいて他サイトの情報を取得したり、更新したりする場合に使用する。基本的な使い方は、このswitch_to_blog関数を使ってブログを切り替え、そのブログに対して処理を行った後、 restore_current_blog関数を使用して元のブログに戻すという流れになる。

このswitch_to_blog関数では、ブログの切り替えを行う前に現在のブログIDをストックし、対で使用されるrestore_current_blog関数ではストックされているブログIDを取り出して元のブログを戻している。なおパラメータ$new_blogが空の場合は、現在のブログIDが適用される。$new_blogが現在のブログIDの場合でも切り替え処理は成功となる。

[5.4.0]'switch_blog'アクションはrestore_current_blog関数からも実行され、どちらから実行されたかを判別可能にするパラメータ$contextが追加された。$contextにはswitch_to_blog関数の場合は'switch'が、restore_current_blog関数の場合は'restore'が格納されている。

使用例

• $blog_idのブログに切り替える。

  <?php
  switch_to_blog( $blog_id );
  
  // ここに切り替えたブログ向けの処理を記述
  
  restore_current_blog();
  ?>

フィルター

アクション

do_action( 'switch_blog', $new_blog, $prev_blog_id, $context );

ソースファイル