WEB制作のための情報サイト / unazuki Library

基本構文と使い方（引数・実行結果）

基本構文

URLをエスケープし、安全な文字列として出力します。また、URLとして適切でない形式の場合、自動的に適切なURLの形式に補完します。例えば指定したURLにhttpsがない場合、自動的にhttpsを補完して完全なURLにします。

esc_url($url,$protocols,$_context);

esc_url($url,$protocols,$_context);

引数

実行結果

戻り値（返す値）：エスケープされたURLを返します。
※表示するにはechoします。

例１．URLをエスケープしなかった場合

下記の例では、scriptが実行されてしまいます。

$url = 'https://example.com<script>alert("危険なスクリプト！");</script>';
echo $url;

$url = 'https://example.com<script>alert("危険なスクリプト！");</script>';
echo $url;

結果：「危険なスクリプト！」というアラートをブラウザに表示

例２．URLをエスケープした場合

下記の例では、URLが適切にエスケープされるため、scriptは実行されません。

$url = 'https://example.com<script>alert("危険なスクリプト！");</script>';
echo esc_url($url);

$url = 'https://example.com<script>alert("危険なスクリプト！");</script>';
echo esc_url($url);

結果：https://example.comscriptalert(危険なスクリプト！);/script

例３．不完全なURLをエスケープした場合

下記の例では、不完全なURLを補完して完全なURLにしています。

$url_imcomplete = 'example.com';
echo esc_url($url_imcomplete,['https']);

$url_imcomplete = 'example.com';
echo esc_url($url_imcomplete,['https']);

結果：https://example.com

よくある使い方

home_url()でトップページのURLを取得した後、エスケープ処理をしてから表示しています。

<a href="<?php echo esc_url(home_url('/')); ?>">トップページ</a>

<a href="<?php echo esc_url(home_url('/')); ?>">トップページ</a>

関連するテンプレートタグ