HOWTO · PHP
PHP でリダイレクトする
このチュートリアルでは、PHP のページから別のページにユーザーをリダイレクトする方法を示します
このページの内容
PHPでリクエストをリダイレクトするには、スクリプトがHTMLなどのコンテンツを出力する前に、header()でLocationレスポンスヘッダーを送信し、その後スクリプトを終了します。次の例では、ブラウザーを指定先のURLへ移動させます。PHPファイルをローカルのWebサーバーに置き、ブラウザーで開くと移動を確認できます。
PHPのheader()関数でURLにリダイレクトする
header()関数はHTTPレスポンスヘッダーを送信します。リダイレクトに使うヘッダーフィールドはLocationで、その値が移動先のURLです。PHPは、PHPタグの外側にある空白も含め、レスポンス本文の内容を出力する前にこのヘッダーを送信する必要があります。リダイレクトのコードは、テンプレートやページ内容を出力する前に、リクエスト処理の冒頭付近に置いてください。
この単独で使える例では、変数に移動先のURLを指定しています。レスポンスの準備後にexitを呼び出すと現在のリクエストが終了し、リダイレクトがなかったかのようにページの残りが続けて処理されることはありません。提供された実行確認では、この例は正常に実行され、標準出力は空でした。リダイレクトは文字列として表示されるのではなく、HTTPレスポンスに含まれます。PHPファイルをローカルのWebサーバー経由でブラウザーから開くと、例で指定した移動先へ移動するはずです。
<?php
$url = 'https://example.com/';
header('Location: ' . $url);
exit;
?>
アプリケーションがユーザーを移動させてよいURLを使ってください。移動先がリクエストデータに由来する場合は、許可リストと照合するか、信頼できるアプリケーションのルートから組み立てて検証します。任意のユーザー入力をリダイレクトに渡すと、訪問者を意図しないサイトへ誘導するおそれがあります。同じアプリケーション内のルートなら、/account/のようなパスで十分なことがよくあります。
HTTPステータスコードを指定するPHPのリダイレクトヘルパーを作る
再利用可能なredirectヘルパーには、移動先とレスポンスのステータスの両方を渡せます。header()の第3引数がステータスコードで、第2引数は同じ名前の既存ヘッダーを置き換えるかどうかを制御します。次のヘルパーは、一時的なリダイレクトによく使われる302を既定値とし、ルートに応じて別のステータスも受け取ります。
<?php
function redirect(string $url, int $statusCode = 302): void
{
header('Location: ' . $url, true, $statusCode);
exit;
}
redirect('https://example.com/', 301);
?>
この例では、移動先が恒久的であることを示すために301を渡しています。このステータスは移転が継続する場合に限って使ってください。ブラウザーなどのクライアントが恒久的なリダイレクトを記憶することがあります。移動先が変わる可能性がある場合は、一時的なリダイレクトである302のほうが適切な既定値です。header()のPHPマニュアルでは関数の引数が説明されており、MDNの301リファレンスでは恒久的なステータスについて確認できます。
提供された実行確認では、このヘルパーの例も正常に実行され、標準出力は空でした。リダイレクトのステータスとLocationヘッダーはHTTPレスポンスの一部であり、テキストとして表示されるものではありません。ブラウザーでの移動を確認するには、PHPファイルをローカルのWebサーバー経由で実行してください。この関数はレスポンスヘッダーを設定した後にリクエストを終了します。実際のアプリケーションでは、ヘルパーを呼び出す前にURLを検証し、移動が一時的か恒久的かに合ったステータスを選んでください。LocationヘッダーとステータスはHTTPレスポンスに含まれるため、ブラウザーにページ本文が届く前にこの方法でリダイレクトできます。
JavaScriptをクライアント側のリダイレクト手段として使う
サーバー側でリダイレクトできない場合は、window.locationを使ってブラウザーに移動を指示できます。これはクライアント側の移動です。PHPがページ内容を送り、ブラウザーがスクリプトを実行します。PHPの出力バッファリングではなく、HTTPレスポンスがサーバー側のリダイレクトに変わるわけでもありません。また、JavaScriptが有効である必要があります。サーバー側でページを送信する前に移動先を決められるなら、PHPのheader()を使ってください。
次のブラウザーページ用スニペットは、この代替手段を示しています。ローカルのWebサーバーで配信できるページに追加し、JavaScriptを有効にしたブラウザーで開くと、移動先へのナビゲーションを確認できます。このスニペットはブラウザー用のソースとして示しており、この記事では実行していません。
<script>
window.location = "https://example.com/";
</script>
このコードはブラウザーで実行されるため、すでに受信したレスポンスの一部として301などのHTTPリダイレクトステータスを送ることはできません。サーバー側のリダイレクトと同様に、移動先を固定するか、移動先の組み立てに使う値を検証してください。クライアント側の移動がページに適している場合に限ってこの方法を使います。JavaScriptを無効にしている訪問者は元のページに留まります。