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

Copy
1<?php
2
3/**
4 * cURL を使用して指定された URL から HTTP ヘッダーとボディを取得します。
5 *
6 * この関数では、CURLHEADER_SEPARATE 定数を CURLOPT_HEADEROPT オプションに設定し、
7 * 特にリダイレクトなどにより複数のヘッダーブロックが返された場合に、
8 * libcurl がそれらを個別に扱うように指示する例を示します。
9 *
10 * @param string $url 取得対象の URL。
11 * @return string|false 成功した場合は HTTP ヘッダーとボディを含む文字列、失敗した場合は false。
12 */
13function fetchUrlContentWithHeaderSeparation(string $url): string|false
14{
15    // cURL セッションを初期化
16    $ch = curl_init();
17
18    // 初期化が失敗した場合はエラーをログに記録し、false を返す
19    if ($ch === false) {
20        error_log('cURL session initialization failed.');
21        return false;
22    }
23
24    // リクエスト先の URL を設定
25    curl_setopt($ch, CURLOPT_URL, $url);
26
27    // レスポンスを直接出力せず、文字列として取得するように設定
28    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
29
30    // レスポンスに HTTP ヘッダーを含めるように設定
31    curl_setopt($ch, CURLOPT_HEADER, true);
32
33    // ヘッダーを分離して扱うオプションを設定
34    // CURLHEADER_SEPARATE は PHP 8.0 で導入された CURLOPT_HEADEROPT オプションの値として使用され、
35    // リダイレクトなどで複数のヘッダーブロックが返された場合に、
36    // 各ヘッダーブロックを個別に処理するように libcurl に指示します。
37    curl_setopt($ch, CURLOPT_HEADEROPT, CURLHEADER_SEPARATE);
38
39    // cURL リクエストを実行し、レスポンスを取得
40    $response = curl_exec($ch);
41
42    // リクエストが失敗した場合はエラーをログに記録
43    if ($response === false) {
44        error_log('cURL request failed: ' . curl_error($ch));
45    }
46
47    // cURL セッションを閉じる
48    curl_close($ch);
49
50    // 取得したレスポンスを返す (成功時はヘッダーとボディを含む文字列、失敗時は false)
51    return $response;
52}
53
54// サンプルコードの実行部分
55// 動作確認用の公開URLを指定します。
56$targetUrl = "https://example.com";
57
58echo "--- URL: {$targetUrl} から情報を取得中 ---\n\n";
59
60// 関数を呼び出し、URLからコンテンツ（ヘッダーとボディ）を取得
61$result = fetchUrlContentWithHeaderSeparation($targetUrl);
62
63// 結果の表示
64if ($result !== false) {
65    echo "--- 取得した HTTP レスポンス (ヘッダーとボディを含む) ---\n";
66    echo $result; // ヘッダーとボディが結合された状態で出力されます
67} else {
68    echo "エラー: URL からのコンテンツ取得に失敗しました。\n";
69}

このPHPサンプルコードは、curl拡張機能を利用して、指定されたURLからHTTPヘッダーとボディを取得するfetchUrlContentWithHeaderSeparation関数を定義しています。特に、この関数はCURLHEADER_SEPARATE定数をCURLOPT_HEADEROPTオプションに設定する使い方を示しています。CURLHEADER_SEPARATEはPHP 8.0で導入された定数で、リダイレクトなどによって複数のHTTPヘッダーブロックがレスポンスとして返された場合に、libcurlがそれらのヘッダーブロックを個別に処理するように指示する役割を持ちます。

関数内部では、まずcurl_init()でcURLセッションを初期化し、CURLOPT_URLでリクエスト先のURLを設定します。CURLOPT_RETURNTRANSFERをtrueに設定することで、レスポンスを直接出力せず文字列として取得し、CURLOPT_HEADERをtrueに設定することでレスポンスにHTTPヘッダーを含めます。ここで重要なのがCURLOPT_HEADEROPTにCURLHEADER_SEPARATEを設定する部分で、これにより複数のヘッダーが返された場合にそれぞれを分離して扱えるようになります。最終的にcurl_exec()でリクエストを実行し、結果を文字列で取得した後、curl_close()でセッションを閉じます。

引数$urlには、情報を取得したいURLを文字列で渡します。戻り値は、cURLリクエストが成功した場合にはHTTPヘッダーとボディを含む文字列が返され、リクエストが失敗した場合にはfalseが返されます。このコードは、Webコンテンツ取得時にヘッダー情報の詳細な制御が必要なシナリオで役立ちます。

Copy
1<?php
2
3/**
4 * CURLHEADER_SEPARATE 定数を使用してHTTPリクエストを送信するサンプルコード。
5 *
6 * CURLHEADER_SEPARATE は CURLOPT_HEADEROPT オプションと組み合わせて使用され、
7 * HTTPヘッダーの扱い方を変更します。
8 * この定数を設定すると、CURLOPT_HEADER が true であっても、curl_exec() の戻り値には
9 * ヘッダー情報が含まれず、ボディデータのみが返されるようになります。
10 * ヘッダー情報は、CURLOPT_HEADERFUNCTION オプションで別途処理するか、
11 * curl_getinfo() などで取得する必要があります。
12 * このコードは、curl_exec() がボディのみを返すことを示します。
13 *
14 * @param string $url リクエストを送信するURL。
15 * @return string|null 取得したレスポンスボディ、またはエラーが発生した場合はnull。
16 */
17function fetchBodyWithSeparatedHeaders(string $url): ?string
18{
19    // cURLセッションを初期化
20    $ch = curl_init();
21
22    if ($ch === false) {
23        echo "cURLの初期化に失敗しました。\n";
24        return null;
25    }
26
27    // リクエスト先のURLを設定
28    curl_setopt($ch, CURLOPT_URL, $url);
29
30    // ヘッダー情報もレスポンスに含めるよう指示 (しかし、CURLHEADER_SEPARATE の効果でボディのみが返る)
31    curl_setopt($ch, CURLOPT_HEADER, true);
32
33    // CURLHEADER_SEPARATE を CURLOPT_HEADEROPT に設定
34    // このフラグは、ヘッダーをメインの出力ストリーム（curl_execの戻り値）から分離します。
35    // PHP 8.0.0で非推奨になりましたが、リファレンス情報に基づいて使用しています。
36    curl_setopt($ch, CURLOPT_HEADEROPT, CURLHEADER_SEPARATE);
37
38    // curl_exec() が結果を文字列として返すように設定
39    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
40
41    // HTTPリクエストを実行し、結果を取得
42    $response = curl_exec($ch);
43
44    // cURLエラーチェック
45    if (curl_errno($ch)) {
46        echo 'cURLエラー: ' . curl_error($ch) . "\n";
47        curl_close($ch);
48        return null;
49    }
50
51    // cURLセッションを終了
52    curl_close($ch);
53
54    // CURLOPT_HEADER が true に設定されているにもかかわらず、
55    // CURLHEADER_SEPARATE の効果により $response にはヘッダーが含まれていません。
56    // そのため、$response は純粋なHTMLボディコンテンツを期待します。
57    echo "--- 取得された内容 (CURLHEADER_SEPARATE の効果によりボディのみ) ---\n";
58    echo substr($response, 0, 500) . "\n...\n"; // 先頭500文字を表示
59
60    return $response;
61}
62
63// サンプルとして取得するURL
64$targetUrl = "https://www.example.com";
65
66// 関数を実行
67$fullResponseBody = fetchBodyWithSeparatedHeaders($targetUrl);
68
69// 実際にはヘッダー情報が必要な場合、CURLOPT_HEADERFUNCTIONなどを利用します。
70// このサンプルは、CURLHEADER_SEPARATE の「分離」効果を示しています。
71if ($fullResponseBody !== null) {
72    echo "\nボディの長さ: " . strlen($fullResponseBody) . "バイト\n";
73}

PHPのCURLHEADER_SEPARATE定数は、cURLというHTTPリクエストを扱うための拡張機能で使用されます。この定数は、curl_setopt()関数を用いてCURLOPT_HEADEROPTオプションに設定することで、HTTPヘッダーの取り扱い方を制御するために利用されます。通常、CURLOPT_HEADERオプションをtrueに設定すると、HTTPレスポンスのヘッダー情報とボディデータの両方がcurl_exec()関数の戻り値として結合されて返されます。

しかし、CURLHEADER_SEPARATE定数をCURLOPT_HEADEROPTに設定すると、CURLOPT_HEADERがtrueであっても、curl_exec()の戻り値にはヘッダー情報が含まれなくなります。その結果、curl_exec()はレスポンスボディのみを返します。ヘッダー情報が必要な場合は、別途CURLOPT_HEADERFUNCTIONオプションでコールバック関数を設定するか、curl_getinfo()関数などを使用して取得する必要があります。

サンプルコードのfetchBodyWithSeparatedHeaders関数は、引数$urlで指定されたURLにHTTPリクエストを送信し、CURLHEADER_SEPARATEの効果によりヘッダー情報を含まない純粋なレスポンスボディのみを取得して文字列として返します。cURLの初期化やリクエストの実行中にエラーが発生した場合はnullを戻り値として返します。このコードは、curl_exec()がボディのみを返す挙動を示しています。なお、PHP 8.0.0以降ではこの定数の使用は非推奨となっています。