概要
wp_is_site_protected_by_basic_auth 関数は、サイトがベーシック認証で保護されているかを調べるための関数です。この関数は、主にサイトのセキュリティに関連する機能を実装する際に使用されます。例えば、以下のような場面でよく使われます：
- サイトを管理するためのプラグインの実装
- 認証保護されたエリアのリダイレクション処理
- 特定のユーザーにのみコンテンツを提供する場合
- 認証されたアクセスを必要とするAPIエンドポイントの開発
- サイトのセキュリティチェック機能
- カスタムユーザーアクセス制御の実装
- 非公開コンテンツの公開設定
- プラグインやテーマの設定画面でのセキュリティオプション追加
構文
bool wp_is_site_protected_by_basic_auth();
パラメータ
この関数は引数を持ちません。
戻り値
true: サイトがベーシック認証で保護されている場合false: サイトがベーシック認証で保護されていない場合
関連する関数
使用可能なバージョン
wp_is_site_protected_by_basic_auth 関数は、WordPress 4.7.0 以降で使用可能です。この関数は特定のバージョンで非推奨または削除されたことはありません。
含まれるコアファイル
この関数は、次のファイルに含まれています。
wp-includes/functions.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 |
サンプルコード
サンプルコード1
if ( wp_is_site_protected_by_basic_auth() ) {
// もしサイトがベーシック認証で保護されている場合の処理
echo 'このサイトは認証が必要です。';
}
このサンプルは、サイトがベーシック認証で保護されている場合にメッセージを表示します。
サンプルコード2
function my_custom_function() {
if ( wp_is_site_protected_by_basic_auth() ) {
// 保護されている場合の特定の処理
return;
}
// 一般的な処理
}
このサンプルは、ベーシック認証で保護されている場合に特定の処理をスキップします。
サンプルコード3
add_action( 'init', 'check_basic_auth' );
function check_basic_auth() {
if ( wp_is_site_protected_by_basic_auth() ) {
// 認証されていない場合のリダイレクト
wp_redirect( home_url('/login') );
exit();
}
}
このサンプルは、サイトが保護されている場合に認証されていないユーザーをログインページにリダイレクトします。
サンプルコード4
function display_content() {
if ( wp_is_site_protected_by_basic_auth() ) {
// コンテンツの表示を制限
echo 'Restricted Content';
} else {
// コンテンツを表示
echo 'Public Content';
}
}
このサンプルは、ベーシック認証のステータスに応じて異なるコンテンツを表示します。
サンプルコード5
if ( ! wp_is_site_protected_by_basic_auth() ) {
// 誰でもアクセス可能な機能を実行
echo 'Welcome to the public site!';
}
このサンプルは、サイトがベーシック認証で保護されていない場合に一般的なウェルカムメッセージを表示します。