概要
wp_is_home_url_using_https
関数は、サイトアドレスが HTTPS を使用しているかを調べるための関数です。この関数はウェブサイトのセキュリティを確認したり、SSL/TLS 証明書が正しく設定されているかを判断するのに役立ちます。
この関数は、以下のようなシナリオでよく使用されます。
- サイトの設定確認
- HTTPS リダイレクトの実装
- セキュリティチェック
- コンテンツの表示条件分岐
- 商品やサービスの保証
- 外部リクエストの確認
- REST API の利用
- Webhooks や通知サービスの設定
構文
wp_is_home_url_using_https( $url = null );
パラメータ
$url
(string|null): 確認するURL。指定しない場合は現在のホームURLが使われる。
戻り値
- (bool): サイトアドレスが HTTPS を使用している場合は true、それ以外の場合は false。
関連する関数
使用可能なワードプレスバージョン
この関数は、WordPress 5.0 以降で利用可能です。
コアファイルのパス
wp-includes/functions.php
サンプルコード
-
ホームURLがHTTPSか確認する
if ( wp_is_home_url_using_https() ) { echo 'このサイトはHTTPSを使用しています。'; } else { echo 'このサイトはHTTPSを使用していません。'; }
このコードは、サイトのホームURLが HTTPS を使用しているかを確認し、その結果を表示します。
-
リダイレクトの実装
function redirect_to_https() { if ( ! wp_is_home_url_using_https() ) { wp_redirect( str_replace( 'http://', 'https://', home_url() ), 301 ); exit(); } } add_action( 'template_redirect', 'redirect_to_https' );
このコードは、HTTP を使用している場合に HTTPS にリダイレクトする処理を行います。
-
セキュリティ向上のための条件分岐
if ( wp_is_home_url_using_https() ) { // セキュリティ向上のための処理 echo 'セキュリティ対策が施されています。'; }
このコードは、サイトが HTTPS を使用している場合に特定の処理を実行します。
-
API の使用確認
function check_api_request() { if ( wp_is_home_url_using_https() ) { // APIリクエストを許可する処理 } else { // エラーメッセージを返す wp_send_json_error( 'HTTPSを使用してください。' ); } } add_action( 'rest_api_init', 'check_api_request' );
このコードは、REST API リクエストが HTTPS で行われているかを確認し、そうでない場合はエラーメッセージを返します。
-
ホームURLを設定する
$url = home_url(); if ( wp_is_home_url_using_https( $url ) ) { echo '指定されたURLはHTTPSです。'; }
このコードは、指定された URL が HTTPS を使用しているかを確認する機能を実装しています。
この関数のアクションでの使用可能性
アクション | 使用例 |
---|---|
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 |
この関数は特定のワードプレスバージョンで非推奨または削除されていません。