switch_to_blog

（MU以降）
switch_to_blog - ブログを切り替える

説明

bool switch_to_blog( int $new_blog [ , bool $deprecated = null ] )
ブログを切り替える。

パラメータ

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

返り値

常にtrueを返す。

注意

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

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

使用例

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

restore_current_blog();
?>

フィルター

直接実行するフィルターはありません。

アクション

[MU]ブログを切り替えると、'switch_blog'アクションを実行する。パラメータ$new_blogは本関数が受け取ったブログIDが、$prev_blog_idには変更前のブログIDが格納されている（$new_blogが現在のブログIDの場合でもこのアクションは実行する）。 
do_action( 'switch_blog', $new_blog, $prev_blog_id );

ソースファイル

/wp-includes/ms-blogs.php

最終更新 : 2016年05月22日 15:08

関連

参考

Code Reference: switch_to_blog

お勧め

query_posts（WP_Queryクラス）で投稿タグを絞り込む（2011年9月14日 更新）

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts（WP_Queryクラス）でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

各種リンクを取得する関数一覧（2014年6月12日 更新）

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク（パーマリンク）を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日 更新）

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

5.3の新機能：サイト管理者のメールアドレスを定期的に確認する（2019年9月27日 更新）

「WordPress 5.3 Beta 1」に記載されていた「Admin Email Verification」の項目が目に留まる。管理者のメールアドレスを定期的に確認するという仕組みがどんなものなのか気になったので、ちょっと調べてみた。

JavaScriptテンプレートを使ってみた（2018年8月21日 更新）

「前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。