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



お勧め

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

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

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。