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

Copy
1<?php
2
3/**
4 * cURLリクエストのヘッダー行を受け取るコールバック関数。
5 *
6 * CURLOPT_HEADERFUNCTION オプションに設定することで、
7 * HTTPレスポンスのヘッダーが到着するたびにこの関数が呼び出されます。
8 *
9 * @param resource $curl cURLセッションのリソース。
10 * @param string $header_line 受け取ったヘッダーの各行。改行コードを含む。
11 * @return int cURLは、この関数が処理したバイト数を返すことを期待しています。
12 *             通常は、受け取ったヘッダー行の長さを返します。
13 */
14function handleReceivedHeader(/** @scrutinizer ignore-unused */ $curl, string $header_line): int
15{
16    // システムエンジニアを目指す初心者向けに、取得されたヘッダー行を分かりやすく出力
17    // trim() で行末の改行コードを除去し、見やすくしています。
18    echo "ヘッダー受信: " . trim($header_line) . "\n";
19
20    // cURLに対して、この関数が処理したバイト数を返します。
21    return strlen($header_line);
22}
23
24/**
25 * CURLOPT_HEADERFUNCTION を使用して、指定されたURLのヘッダー情報を取得するサンプル。
26 *
27 * この関数はHTTP GETリクエストを実行し、レスポンスのヘッダー情報を
28 * カスタムコールバック関数 `handleReceivedHeader` を介して処理します。
29 *
30 * @param string $url アクセスするターゲットURL。
31 * @return bool リクエストが成功し、ヘッダー処理が完了した場合は true、それ以外は false。
32 */
33function fetchUrlHeadersWithCallback(string $url): bool
34{
35    // 1. cURLセッションを初期化します。
36    $ch = curl_init();
37
38    if ($ch === false) {
39        echo "エラー: cURLセッションの初期化に失敗しました。\n";
40        return false;
41    }
42
43    // 2. cURLオプションを設定します。
44    // アクセスするURLを設定します。
45    curl_setopt($ch, CURLOPT_URL, $url);
46
47    // レスポンスの本体を文字列として取得するように設定します。
48    // (ヘッダーはコールバック関数で処理するため、本体のみを取得します)
49    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
50
51    // レスポンスにヘッダーを含めないように設定します。
52    // これにより、CURLOPT_HEADERFUNCTION がヘッダー処理の主役となります。
53    curl_setopt($ch, CURLOPT_HEADER, false);
54
55    // CURLOPT_HEADERFUNCTION に、定義したコールバック関数を設定します。
56    // HTTPレスポンスのヘッダー行が到着するたびに 'handleReceivedHeader' 関数が呼び出されます。
57    curl_setopt($ch, CURLOPT_HEADERFUNCTION, 'handleReceivedHeader');
58
59    echo "--- URL: '{$url}' のヘッダー情報を取得中 ---\n";
60
61    // 3. cURLセッションを実行し、レスポンスを取得します。
62    $response_body = curl_exec($ch);
63
64    // 4. エラーがないか確認します。
65    if (curl_errno($ch)) {
66        echo "cURLエラー (" . curl_errno($ch) . "): " . curl_error($ch) . "\n";
67        curl_close($ch);
68        return false;
69    }
70
71    // 5. レスポンスの本体を出力します (もしあれば)。
72    echo "\n--- レスポンス本体 ---\n";
73    if ($response_body !== false && $response_body !== '') {
74        echo substr($response_body, 0, 500) . (strlen($response_body) > 500 ? "...\n" : "\n"); // 長すぎる場合は一部のみ表示
75    } else {
76        echo "レスポンス本体は空です。\n";
77    }
78
79    // 6. cURLセッションを閉じます。
80    curl_close($ch);
81
82    return true;
83}
84
85// スクリプトの実行例
86// 実際にアクセス可能なURLを指定してください。
87// 例: 'https://www.google.com/' や 'https://example.com/' など
88$targetUrl = 'https://example.com/';
89
90if (fetchUrlHeadersWithCallback($targetUrl)) {
91    echo "\n指定されたURLへのリクエストは正常に処理されました。\n";
92} else {
93    echo "\nURLへのリクエスト処理中にエラーが発生しました。\n";
94}
95
96?>

PHPのCURLOPT_HEADERFUNCTIONは、cURL拡張機能でHTTPリクエストを送信する際に、サーバーからのレスポンスヘッダー行を個別に処理するためのコールバック関数を設定する定数です。この設定により、開発者はヘッダー情報が到着するたびに特定の処理を実行できます。

サンプルコードでは、handleReceivedHeaderという関数がコールバック関数として定義されています。この関数は、HTTPレスポンスのヘッダー行が一つずつ到着するたびにcURLによって呼び出されます。引数$header_lineには、受け取ったヘッダーの各行（例: Content-Type: text/html\r\n）が文字列として渡され、コードではその内容を画面に表示しています。コールバック関数は、処理したヘッダー行のバイト数をint型でcURLに返す必要があります。

次に、fetchUrlHeadersWithCallback関数が、CURLOPT_HEADERFUNCTIONの具体的な使用方法を示しています。この関数はcURLセッションを初期化し、アクセスするURLや、レスポンスの本体を文字列として取得する設定を行います。ここで重要なのは、CURLOPT_HEADERをfalseに設定することで、cURLがレスポンスヘッダーを自動的にレスポンス本体に含めないようにし、代わりにCURLOPT_HEADERFUNCTIONにhandleReceivedHeader関数を設定している点です。これにより、cURLはヘッダー行を受信するたびにhandleReceivedHeaderを呼び出し、カスタム処理を行います。最終的にcURLリクエストを実行し、エラーがなければ、指定されたURLのヘッダー情報がコールバック関数によって画面に表示され、リクエストは正常に完了します。この機能は、特定のヘッダー情報を抜き出したり、デバッグ情報をログに記録したりする際に活用されます。

Copy
1<?php
2
3/**
4 * プログラミング言語: PHP
5 * バージョン: 8
6 * 大分類: extension
7 * 小分類: constant
8 * 所属クラス:
9 * 名前: CURLOPT_HEADERFUNCTION
10 * 引数: なし
11 * 戻り値: 戻り値なし
12 * キーワード: php curlopt_headerfunction example
13 *
14 * CURLOPT_HEADERFUNCTION は、HTTP レスポンスのヘッダーを受信するたびに呼び出されるコールバック関数を設定するために使用されます。
15 * このコールバック関数は、通常2つの引数（cURL ハンドルとヘッダーラインの文字列）を受け取り、
16 * 処理したバイト数を（通常はヘッダーラインの文字列長を）返す必要があります。
17 */
18
19/**
20 * cURLから受信した各HTTPヘッダーラインを処理するためのコールバック関数。
21 *
22 * @param resource $curl cURLリソースハンドル。
23 * @param string $headerLine 受信したHTTPヘッダーライン。
24 * @return int 処理されたバイト数（必須）。
25 */
26function handleResponseHeader($curl, string $headerLine): int
27{
28    // ヘッダーラインが空でない場合（例：CRLFのみでない場合）に表示
29    $trimmedHeader = trim($headerLine);
30    if (!empty($trimmedHeader)) {
31        echo "受信ヘッダー: " . $trimmedHeader . "\n";
32    }
33    // cURL に対して、このヘッダーラインをすべて処理したことを示す
34    return strlen($headerLine);
35}
36
37// cURLセッションを初期化
38$ch = curl_init();
39
40if ($ch === false) {
41    die("cURLの初期化に失敗しました。\n");
42}
43
44// 取得するURLを設定
45curl_setopt($ch, CURLOPT_URL, "http://example.com");
46
47// レスポンスボディを文字列として返すように設定（ヘッダーはコールバックで処理）
48curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
49
50// ヘッダーを受信するたびに呼び出されるコールバック関数を設定
51// ここで CURLOPT_HEADERFUNCTION に定義した関数名を指定します
52curl_setopt($ch, CURLOPT_HEADERFUNCTION, "handleResponseHeader");
53
54// cURLセッションを実行
55$responseBody = curl_exec($ch);
56
57// エラーチェック
58if (curl_errno($ch)) {
59    echo 'cURLエラー: ' . curl_error($ch) . "\n";
60} else {
61    echo "\n--- レスポンスボディ ---\n";
62    echo $responseBody;
63}
64
65// cURLセッションを閉じる
66curl_close($ch);
67
68?>

CURLOPT_HEADERFUNCTIONは、PHPのcURL拡張機能において、HTTPリクエストのレスポンスヘッダーをサーバーから受信するたびに特定のコールバック関数を呼び出すための定数です。これにより、受信したヘッダー情報をプログラムでリアルタイムに処理できます。

サンプルコードでは、handleResponseHeaderという名前のコールバック関数を定義しています。この関数は、cURLリソースハンドルと、受信したHTTPヘッダーラインの文字列を引数として受け取ります。関数内では、受け取ったヘッダーラインを整形して表示し、そのヘッダーラインの文字列長を整数として返します。この戻り値は、cURLに対してヘッダーラインが正常に処理されたことを通知するために必須となります。

プログラムの実行部分では、まずcurl_initでcURLセッションを初期化し、CURLOPT_URLでアクセス対象のURLを指定しています。CURLOPT_RETURNTRANSFERをtrueに設定することで、レスポンスボディを文字列として取得するよう指定します。そして、CURLOPT_HEADERFUNCTIONに定義したhandleResponseHeader関数名を指定することで、ヘッダー受信時のコールバックを設定しています。

curl_execを実行すると、ウェブサイトへのリクエストが送信されます。サーバーからのレスポンスヘッダーは一つずつhandleResponseHeader関数によって処理され、コンソールに表示されます。その後、レスポンスボディは$responseBody変数に格納され、最後に画面に表示されます。処理が完了したら、curl_closeでcURLセッションを終了し、リソースを解放しています。