概要
wp_is_maintenance_mode関数は、WordPressがメンテナンスモードであるかどうかを確認するための関数です。メンテナンスモードは、サイトの更新やメンテナンス中に、ユーザーに対して特別なメッセージや一時的なページを表示するために使用されます。この関数がよく使用されるシーンは以下の通りです：
- サイトの更新時にメンテナンスモードを確認する場合。
- メンテナンスページにリダイレクトする際の条件設定。
- 外部APIコールを行う際にメンテナンス状態を考慮する場合。
- 自動バックアップスクリプトの実行時にメンテナンスモードかを確認する場合。
- テーマやプラグインの更新中にユーザーに対する通知を管理する場合。
- 特定のページまたは投稿の表示を停止する条件として使用する場合。
- エラーログの出力やデバッグ中にメンテナンス状態を考慮する場合。
- ユーザーのアクセス権設定の調整に役立てる場合。
構文
wp_is_maintenance_mode();
パラメータ
この関数にはパラメータはありません。
戻り値
true：現在メンテナンスモードである場合。false：現在メンテナンスモードでない場合。
関連する関数
使用可能なバージョン
- この関数はWordPress 4.0以降で使用可能です。
コアファイルのパス
wp-includes/load.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 |
非推奨または削除されたバージョン
- 現在のところ、
wp_is_maintenance_mode関数は非推奨または削除されたことはありません。
サンプルコード
サンプルコード1: メンテナンスモードの確認
if (wp_is_maintenance_mode()) {
// メンテナンスモード中
echo 'サイトは現在メンテナンス中です。';
} else {
// 通常の処理
echo 'サイトは利用可能です。';
}
説明：このコードは、サイトがメンテナンスモードであるかを確認し、適切なメッセージを表示します。
サンプルコード2: メンテナンスページへのリダイレクト
if (wp_is_maintenance_mode()) {
wp_redirect(home_url('/maintenance.php'));
exit;
}
説明：サイトがメンテナンスモードの場合、指定したメンテナンスページにリダイレクトします。
サンプルコード3: APIコールの条件分岐
if (!wp_is_maintenance_mode()) {
// APIコールを実行
$response = wp_remote_get('http://api.example.com/data');
}
説明：メンテナンスモードでない場合のみ、外部APIからデータを取得します。
サンプルコード4: バックアップスクリプトの実行
if (!wp_is_maintenance_mode()) {
// バックアップ処理を実行
perform_backup();
}
説明：メンテナンスモードでない場合にのみ、バックアップ処理を実行します。
サンプルコード5: メンテナンス状態でのエラーログ出力
if (wp_is_maintenance_mode()) {
error_log('メンテナンスモード中のエラーがあります。');
}
説明：メンテナンスモードのときにエラーログを記録します。