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

お勧め

WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧（2018年5月27日 更新）

WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。

ホームディレクトリから過去のファイルを削除する（2013年1月27日 更新）

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

wp_titleからwp_get_document_titleへ（2018年5月27日 更新）

先週、WordPress 4.4 beta1（以降4.4 beta1）が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

検索ワード「-10,000円」を検索できるようにしたい（2018年5月27日 更新）

とあるサイトで「-10,000円」をキーワードに検索した際、予想と異なるページが表示され、ちょっと驚いた。今回はその原因調査と対策についてまとめてみた。

ダッシュボードのフィードボックスをカスタマイズ（2011年7月8日 更新）

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する（管理者権限）。