【PHP8.x】CURLOPT_FOLLOWLOCATION定数の使い方

Copy
1<?php
2
3/**
4 * CURLOPT_FOLLOWLOCATION の使用例。
5 * HTTPリダイレクトに自動的に追従して最終的なコンテンツを取得します。
6 *
7 * @param string $url 取得するURL。このURLがリダイレクトを返す可能性があります。
8 * @return string|false 最終的なURLから取得されたコンテンツ、またはエラー時にfalseを返します。
9 */
10function fetchContentFollowingRedirects(string $url): string|false
11{
12    // cURLセッションを初期化します。
13    $ch = curl_init();
14
15    if ($ch === false) {
16        echo "エラー: cURLセッションの初期化に失敗しました。\n";
17        return false;
18    }
19
20    // 取得対象のURLを設定します。
21    curl_setopt($ch, CURLOPT_URL, $url);
22
23    // CURLOPT_FOLLOWLOCATION を true に設定することで、cURLはHTTPリダイレクト（例: 301 Moved Permanently, 302 Found）に自動的に追従します。
24    // これにより、サーバーが別のURLへの移動を指示した場合でも、最終的な目的地のコンテンツを取得できます。
25    // デフォルトではこのオプションは false (リダイレクトに追従しない) です。
26    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
27
28    // curl_exec() が結果を直接出力するのではなく、文字列として返すように設定します。
29    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
30
31    // cURLリクエストを実行し、応答を取得します。
32    $response = curl_exec($ch);
33
34    // cURLリクエスト中にエラーが発生したか確認し、エラーがあれば出力します。
35    if (curl_errno($ch)) {
36        echo 'cURLエラー (' . curl_errno($ch) . '): ' . curl_error($ch) . "\n";
37        curl_close($ch);
38        return false;
39    }
40
41    // リダイレクトが発生した場合に、最初にリクエストしたURLと最終的にコンテンツを取得したURLを表示します。
42    $effectiveUrl = curl_getinfo($ch, CURLINFO_EFFECTIVE_URL);
43    echo "リクエスト元のURL: " . $url . "\n";
44    echo "最終的にコンテンツを取得したURL (Effective URL): " . $effectiveUrl . "\n\n";
45
46    // cURLセッションを閉じ、リソースを解放します。
47    curl_close($ch);
48
49    return $response;
50}
51
52// 使用例: リダイレクトを伴う可能性のあるURLを指定します。
53// 'https://httpbin.org/redirect/1' は、一度リダイレクトしてから最終的なコンテンツを返します。
54$initialUrl = 'https://httpbin.org/redirect/1';
55echo "--- CURLOPT_FOLLOWLOCATION を有効にした場合の動作 ---\n";
56$content = fetchContentFollowingRedirects($initialUrl);
57
58if ($content !== false) {
59    echo "取得したコンテンツの最初の200文字:\n";
60    echo substr($content, 0, 200) . "...\n";
61} else {
62    echo "コンテンツの取得に失敗しました。\n";
63}
64
65?>

CURLOPT_FOLLOWLOCATIONは、PHPのcURL拡張機能で利用される定数の一つで、HTTPリクエストがリダイレクト応答（例: 301 Moved Permanently、302 Foundなど）を受け取った際に、そのリダイレクト先に自動的に追従するかどうかを設定します。この定数自体は引数を取らず、戻り値もありませんが、curl_setopt()関数と組み合わせて使用することで、cURLの挙動を制御します。

サンプルコードのfetchContentFollowingRedirects関数は、引数として指定された$urlに対してHTTPリクエストを実行し、そのコンテンツを取得します。関数内でcurl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);と設定することにより、サーバーが「このページは別のURLへ移動しました」と指示した場合でも、cURLは自動的に新しいURLへリクエストを再送信し、最終的なコンテンツを取得します。このオプションがfalse（デフォルト）の場合、cURLはリダイレクト元の応答をそのまま返します。

戻り値としては、最終的に取得されたコンテンツの文字列、または通信エラー時にfalseを返します。サンプルコードの実行結果では、最初にリクエストしたURLと、リダイレクト追従によってコンテンツを取得した最終的なURL（Effective URL）が表示されており、CURLOPT_FOLLOWLOCATIONの機能が具体的に示されています。これにより、システムエンジニアを目指す初心者の方も、ウェブ通信におけるリダイレクト処理の重要性を理解しやすくなります。