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

お勧め

Login rebuilder 2.6.0の新機能紹介（2019年4月22日 更新）

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

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

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

classic editorプラグインを試してみた（2018年12月10日 更新）

WordPress 5.0 beta1のリリースにあわせて旧エディター環境を実現できる「classic editor」（バージョン0.5.0）が公開された。自分が公開しているプラグインの一部が旧エディター環境に依存していることもあり、さっそく試してみた。WordPress 5.0正式リリースに合わせてclassic editorも1.0がリリースされたので、それについて追記しました。

コメントの「ウェブサイト」止めました（2014年4月15日 更新）

とあるサイトのスパムコメントが多く、その都度のスパム指定するのが面倒である。これまでいくつか対策を行ってきたが、そういった対応にもいい加減うんざりしてきたので、試験的に「ウェブサイト」を無効化しようと思った。

プラグインの設定ページもレスポンシブ対応（2014年6月3日 更新）

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。