restore_current_blog

（MU以降）
restore_current_blog - ブログを切り替え前に戻す

説明

bool restore_current_blog()
ブログを切り替え前に戻す。

パラメータ

パラメータはありません。

返り値

ブログを切り替え前に戻した場合はtrueを返す。ストックされているブログIDがない場合はfalseを返す。

注意

基本的な使い方としては、 switch_to_blog関数でブログを切り替え、そのブログ向けの処理を行った後、このrestore_current_blog関数を使用して元のブログに戻すという流れになる。

[5.4.0]'switch_blog'アクションはswitch_to_blog関数からも実行され、どちらから実行されたかを判別可能にするパラメータ$contextが追加された。$contextにはrestore_current_blog関数の場合は'restore'が、switch_to_blog関数の場合は'switch'が格納されている。

使用例

  • ブログを元に戻す。
    <?php
switch_to_blog( $blog_id );

// ここに切り替えたブログ向けの処理を記述

restore_current_blog();
?>

フィルター

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

アクション

[MU]ブログの切り替えると（元に戻すと）、'switch_blog'アクションを実行する。パラメータ$blogは切り替え後のブログIDが、$prev_blog_idには本関数呼び出し時のブログIDが格納されている。[5.4.0]パラメータ$contextには'restore'が格納されている。 
do_action( 'switch_blog', $blog, $prev_blog_id, $context );

ソースファイル

/wp-includes/ms-blogs.php

最終更新 : 2020年04月07日 13:05

関連

参考

Code Reference: restore_current_blog

お勧め

5.5で非推奨になる関数名について（2020年8月12日 更新）

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2（以降Beta 2）」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

meta_compare_key使ってみた（2019年3月19日 更新）

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。

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

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

初期化に関連するアクションのおさらい（2013年11月27日 更新）

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

全投稿を取得するのはnopaging=1でいい（2011年8月31日 更新）

query_posts関数（またはWP_Queryクラス）を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」－「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには？