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

Copy
1<?php
2
3/**
4 * 指定されたURLにCURLリクエストを送信し、リダイレクトの最大追跡回数を設定します。
5 *
6 * @param string $url アクセスするターゲットURL。
7 * @param int $maxRedirects 自動的に追跡するリダイレクトの最大回数。
8 *                          CURLOPT_MAXREDIRS オプションに設定されます。
9 * @return string|null リクエストの成功時にレスポンスボディを文字列で返します。
10 *                     失敗した場合は null を返します。
11 */
12function makeCurlRequestWithRedirectLimit(string $url, int $maxRedirects): ?string
13{
14    // CURLセッションを初期化します。
15    $ch = curl_init();
16
17    // CURL初期化の失敗チェック
18    if ($ch === false) {
19        // CURLの初期化に失敗した場合の処理（例: エラーログへの記録）
20        error_log("CURLセッションの初期化に失敗しました。");
21        return null;
22    }
23
24    // CURLオプションを設定します。
25    // アクセスするURLを設定
26    curl_setopt($ch, CURLOPT_URL, $url);
27    // リクエストの実行結果を文字列として返すように設定
28    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
29    // HTTPリダイレクトを自動的に追跡するように設定
30    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
31    // 自動的に追跡するリダイレクトの最大回数を設定します。
32    // CURLOPT_MAXREDIRS は、この最大回数を指定するための定数です。
33    // この値を超えると、CURLはリダイレクトの追跡を停止します。
34    curl_setopt($ch, CURLOPT_MAXREDIRS, $maxRedirects);
35    // 接続および応答のタイムアウトを設定（秒単位）
36    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
37
38    // CURLリクエストを実行します。
39    $response = curl_exec($ch);
40
41    // CURL実行エラーの確認
42    if (curl_errno($ch)) {
43        // CURLリクエスト中にエラーが発生した場合の処理（例: エラーログへの記録）
44        error_log('CURLエラー: ' . curl_error($ch));
45        $response = null;
46    }
47
48    // CURLセッションを閉じ、リソースを解放します。
49    curl_close($ch);
50
51    return $response;
52}
53
54// 以下は、この関数を実際に利用する際の例です。
55// このコードブロックは、出力条件に合わせてコメントアウトされています。
56/*
57// 例1: リダイレクトを2回まで許可してウェブサイトにアクセス
58$targetUrl1 = 'http://example.com'; // このURLは通常HTTPS版へリダイレクトします
59$maxRedirectsAllowed1 = 2;
60echo "URL: {$targetUrl1} にリダイレクト最大 {$maxRedirectsAllowed1} 回でアクセスします。\n";
61$content1 = makeCurlRequestWithRedirectLimit($targetUrl1, $maxRedirectsAllowed1);
62
63if ($content1 !== null) {
64    echo "--- レスポンスの一部 (リダイレクト許容: {$maxRedirectsAllowed1}回) ---\n";
65    echo substr($content1, 0, 500) . (strlen($content1) > 500 ? '...' : '') . "\n";
66    echo "--------------------------------------------------------\n\n";
67} else {
68    echo "リクエスト失敗 (リダイレクト許容: {$maxRedirectsAllowed1}回)。\n\n";
69}
70
71// 例2: リダイレクトを一切追跡しない（最大0回）でウェブサイトにアクセス
72// この場合、通常は最初のリダイレクト応答（例: 301 Moved Permanently）を受け取ります。
73$targetUrl2 = 'http://example.com';
74$maxRedirectsAllowed2 = 0; // リダイレクトを追跡しない
75echo "URL: {$targetUrl2} にリダイレクト最大 {$maxRedirectsAllowed2} 回でアクセスします。\n";
76$content2 = makeCurlRequestWithRedirectLimit($targetUrl2, $maxRedirectsAllowed2);
77
78if ($content2 !== null) {
79    echo "--- レスポンスの一部 (リダイレクト許容: {$maxRedirectsAllowed2}回) ---\n";
80    echo substr($content2, 0, 500) . (strlen($content2) > 500 ? '...' : '') . "\n";
81    echo "--------------------------------------------------------\n";
82} else {
83    echo "リクエスト失敗 (リダイレクト許容: {$maxRedirectsAllowed2}回)。\n";
84}
85*/

このPHPコードは、HTTPリクエストを送信する際に発生するリダイレクトの自動追跡回数を制御する方法を示しています。CURLOPT_MAXREDIRSは、このリダイレクトの最大追跡回数を設定するために使用される定数です。

サンプルコードのmakeCurlRequestWithRedirectLimit関数は、curl_init()でCURLセッションを開始し、curl_setopt()で様々なオプションを設定します。特に、CURLOPT_FOLLOWLOCATIONをtrueに設定することで、ウェブサイトのリダイレクト（例: HTTPからHTTPSへの転送）を自動的に追跡するようになります。そして、CURLOPT_MAXREDIRSに引数として渡された整数値を設定することで、CURLが追跡するリダイレクトの最大回数を指定します。この回数を超えると、CURLはそれ以上のリダイレクトを追跡せずに停止します。

この関数は、アクセスしたいターゲットURLを$url引数として、自動追跡を許可するリダイレクトの最大回数を$maxRedirects引数として受け取ります。リクエストが成功した場合、ウェブサーバーからのレスポンスボディが文字列として返されます。しかし、CURLセッションの初期化失敗やリクエスト実行中にエラーが発生した場合は、nullが戻り値として返されます。これにより、ウェブアクセス時のリダイレクト挙動を安全かつ意図的に制御することが可能になります。