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



お勧め

投稿記事でrubyタグを使えるようにする(前編)(2012年1月25日 更新)

rubyなどのルビ関連タグはIEの独自サポートから始まり、少し前のChrome/Safariが追随して利用できるようになっている。Firefoxはいまだにサポートしていないのだが、それなりに代替表示されるので、投稿記事で使えるようにしてみた。

WordPressの鼓動(2013年10月1日 更新)

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。

一定時間でログアウトする(2013年5月23日 更新)

ログイン関係を調べている関係で、 wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。

5.3の機能強化:カスタムフィールドキーの条件指定が使いやすくなる(2019年11月19日 更新)

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。