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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。