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

お勧め

プラグイン「Login rebuilder」はログイン時の履歴（ログ）や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

古めのリビジョンを削除した時のメモ（2022年5月16日更新）

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

決まった値を返すだけの関数群（2018年5月27日更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

「Align widgets horizontally」プラグインのフィルター使用例（2024年5月15日更新）

ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

説明

パラメータ

返り値

注意

使用例

フィルター

アクション

ソースファイル

関連

参考

お勧め