概要
wp_is_site_url_using_https
関数は、WordPress アドレスが HTTPS を使用しているかどうかを調べるための関数です。この関数は、以下のようなシナリオでよく使用されます。
- SSL 証明書が正しく設定されているかの確認
- セキュリティ強化のための設定確認
- HTTPS リダイレクトを適用する前のチェック
- サイトが HTTPS に移行する際のトラブルシューティング
- ログインページのセキュリティ強化
- 外部サービスとの連携設定(API 通信など)
- プラグイン開発時の環境設定
- サイトのパフォーマンス改善施策の検討
構文
bool wp_is_site_url_using_https();
パラメータ
この関数にはパラメータはありません。
戻り値
この関数は、サイトの URL が HTTPS を使用している場合は true
を、そうでない場合は false
を返します。
関連する関数
使用可能なバージョン
wp_is_site_url_using_https
は WordPress 4.4 以降で使用可能です。
コアファイルのパス
この関数は wp-includes/functions.php
に含まれています。
サンプルコード
サンプルコード 1
if ( wp_is_site_url_using_https() ) {
echo 'このサイトは HTTPS を使用しています。';
} else {
echo 'このサイトは HTTPS を使用していません。';
}
このコードは、サイトが HTTPS を使用しているかどうかをチェックし、結果に応じてメッセージを表示します。
サンプルコード 2
function redirect_if_not_https() {
if ( ! wp_is_site_url_using_https() ) {
wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], 301 );
exit;
}
}
add_action( 'template_redirect', 'redirect_if_not_https' );
このコードは、HTTPS を使用していない場合に自動的に HTTPS にリダイレクトする機能を実装しています。
サンプルコード 3
function my_theme_setup() {
if ( ! wp_is_site_url_using_https() ) {
add_action( 'wp_footer', function() {
echo '<script>alert("注意: このサイトはHTTPを使用しています。");</script>';
});
}
}
add_action( 'after_setup_theme', 'my_theme_setup' );
このコードは、HTTPS が使用されていない場合に警告メッセージを表示する JavaScript を追加します。
サンプルコード 4
function check_https_and_set_cookie() {
if ( wp_is_site_url_using_https() ) {
setcookie('SecureCookie', 'value', 0, '/', '', true, true);
}
}
add_action( 'init', 'check_https_and_set_cookie' );
このコードは、HTTPS を使用している場合にセキュアクッキーを設定します。
サンプルコード 5
function custom_ssl_message() {
if ( wp_is_site_url_using_https() ) {
return 'SSLが有効です。';
} else {
return 'SSLが無効です。';
}
}
add_shortcode( 'ssl_status', 'custom_ssl_message' );
このコードは、ショートコードを利用してサイトの SSL ステータスを表示する機能を追加します。
この関数のアクションでの使用可能性
アクション名 | 使用例 |
---|---|
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 |
非推奨または削除されたバージョン
現在のところ、この関数は非推奨または削除されたバージョンはありません。