概要
wp_is_recovery_mode 関数は、WordPressがリカバリーモード中かどうかを検査するための関数です。この機能は、プラグインやテーマの開発者がサイトのデバッグやトラブルシューティングを実施する際に非常に便利です。リカバリーモードは、サイトが正常に動作しない場合に、ユーザーが WordPress ダッシュボードにアクセスして問題を修正するための手段を提供します。
よく使用される場面は以下の通りです：
1. プラグインの初期化処理をリカバリーモード中に行う。
2. エラーログの出力をリカバリーモード中のみ行う。
3. 特定のスタイルシートやスクリプトをリカバリーモードの際に読み込む。
4. 管理者用のダッシュボードウィジェットをリカバリーモードのときのみ表示させる。
5. 特定のアクションフックで条件付きで処理を実行する。
6. ユーザーへ別のメッセージを表示する。
7. 特定のAPIをリカバリーモードの際に制限する。
8. カスタムデバッグメッセージを表示する。
構文
wp_is_recovery_mode();
パラメータ
この関数にはパラメータはありません。
戻り値
true: リカバリーモード中の場合false: 通常モードの場合
関連する関数
使用可能なバージョン
wp_is_recovery_mode 関数は、WordPress 5.2以降で使用可能です。
コアファイルのパス
この関数は、wp-includes/recovery-mode.php に含まれています。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | 〇 |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | |
| send_headers | 〇 |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head | 〇 |
非推奨または削除されたバージョン
特に非推奨または削除されたバージョンはありません。