説明
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の場合でも切り替え処理は成功となる。
[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(); ?>
フィルター
直接実行するフィルターはありません。アクション
[MU]ブログを切り替えると、'switch_blog'アクションを実行する。パラメータ$new_blogは本関数が受け取ったブログIDが、$prev_blog_idには変更前のブログIDが格納されている（$new_blogが現在のブログIDの場合でもこのアクションは実行する）。[5.4.0]パラメータ$contextには'switch'が格納されている。do_action( 'switch_blog', $new_blog, $prev_blog_id, $context );ソースファイル
/wp-includes/ms-blogs.php最終更新 : 2020年04月07日 12:56
関連
お勧め
HTML編集モードに定型文ボタンを追加する（2011年6月1日 更新）
投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。4.4では投稿ページも専用テンプレートが適用できる（2018年5月27日 更新）
従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。
3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目（2011年7月6日 更新）
新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。標準で使用できる数少ないショートコード[caption]とは（2018年5月27日 更新）
画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。ショートコードを含んだページを表示する前に何か処理する（2014年5月28日 更新）
固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。