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

Copy
1<?php
2
3/**
4 * 指定されたURLにHTTP GETリクエストを送信し、カスタムHTTPヘッダーを設定します。
5 *
6 * この関数は、CURLOPT_HTTPGET を使用してGETメソッドを明示し、
7 * CURLOPT_HTTPHEADER を使用してカスタムヘッダーをリクエストに追加する方法を示します。
8 *
9 * @param string $url リクエストを送信するターゲットURL。
10 * @return string|false リクエストの成功時には応答ボディの文字列、失敗時には false を返します。
11 */
12function sendHttpGetRequestWithCustomHeaders(string $url): string|false
13{
14    // 1. cURLセッションを初期化します。
15    //    これは、HTTPリクエストを行うための準備ステップです。
16    $ch = curl_init();
17
18    // 2. cURLオプションを設定します。
19    //    curl_setopt() を使って、リクエストの振る舞いを細かく制御します。
20
21    //    リクエスト先のURLを設定します。
22    curl_setopt($ch, CURLOPT_URL, $url);
23
24    //    応答をブラウザに出力する代わりに、関数の戻り値として文字列で取得するように設定します。
25    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
26
27    //    HTTP GETメソッドを明示的に使用するように設定します。
28    //    これはデフォルトの動作ですが、他のリクエストタイプとの混同を避けるために明示的に指定することがあります。
29    curl_setopt($ch, CURLOPT_HTTPGET, true);
30
31    //    カスタムHTTPヘッダーを設定します。
32    //    配列の各要素が 'ヘッダー名: ヘッダー値' の形式になります。
33    $customHeaders = [
34        'User-Agent: MyCustomPhpApp/1.0 (PHP 8)', // リクエスト元を識別するカスタムUser-Agent
35        'Accept: application/json',                 // JSON形式の応答を優先して受け入れることを指定
36        'X-Requested-With: XMLHttpRequest'          // AJAXリクエストであることを示すカスタムヘッダー例
37    ];
38    curl_setopt($ch, CURLOPT_HTTPHEADER, $customHeaders); // 定義したヘッダーをリクエストに追加します。
39
40    // 3. cURLセッションを実行し、応答を取得します。
41    $response = curl_exec($ch);
42
43    // 4. エラーがあるか確認します。
44    //    cURL操作中に問題が発生した場合は、エラーメッセージを表示します。
45    if (curl_errno($ch)) {
46        echo 'cURLエラー (' . curl_errno($ch) . '): ' . curl_error($ch) . PHP_EOL;
47        $response = false; // エラーが発生した場合はfalseを返します
48    }
49
50    // 5. cURLセッションを閉じ、使用したリソースを解放します。
51    curl_close($ch);
52
53    return $response;
54}
55
56// --- 関数利用の例 ---
57// テスト用の公開APIエンドポイント（jsonplaceholder.typicode.com はダミーデータを提供するサービスです）
58$targetUrl = 'https://jsonplaceholder.typicode.com/posts/1';
59
60echo "URL: " . $targetUrl . PHP_EOL;
61echo "HTTP GETリクエストとカスタムヘッダーを送信中..." . PHP_EOL . PHP_EOL;
62
63// 関数を呼び出し、結果を取得します
64$result = sendHttpGetRequestWithCustomHeaders($targetUrl);
65
66// 結果を表示します
67if ($result !== false) {
68    echo "--- 応答ボディ ---" . PHP_EOL;
69    echo $result . PHP_EOL;
70    echo "-----------------" . PHP_EOL;
71} else {
72    echo "リクエストの実行に失敗しました。" . PHP_EOL;
73}
74
75?>

このサンプルコードは、PHPで外部のウェブサービスに対してHTTP GETリクエストを送信し、同時にカスタムHTTPヘッダーを設定する方法を示しています。CURLOPT_HTTPGETは、cURLを使ってGETメソッドでリクエストを行うことを明示的に指定するための定数です。これは通常、GETがデフォルトの動作ですが、コードの意図を明確にするために使用されることがあります。

また、CURLOPT_HTTPHEADERオプションを使うことで、User-AgentやAcceptといった標準的なヘッダーに加え、任意のカスタムヘッダーをリクエストに追加できます。これにより、APIキーの送信や特定のアプリケーションからのリクエストであることを示すなど、細かな制御が可能になります。

コードでは、まずcurl_init()でcURLセッションを初期化し、curl_setopt()関数でリクエスト先のURL、応答の取得方法、そしてCURLOPT_HTTPGETとCURLOPT_HTTPHEADERを含む各種オプションを設定しています。設定後、curl_exec()でリクエストを実行し、curl_errno()でエラーがあれば検出し、最後にcurl_close()でセッションを閉じます。

sendHttpGetRequestWithCustomHeaders関数は、リクエスト先のURLを文字列として引数に受け取ります。そして、成功した場合はウェブサービスからの応答ボディの文字列を、失敗した場合はfalseを戻り値として返します。この一連の処理により、HTTP通信の柔軟な実装が可能になります。

Copy
1<?php
2
3/**
4 * 指定されたURLからウェブコンテンツを取得します。
5 * HTTP GETリクエストを使用し、HTTPリダイレクト（Locationヘッダー）を自動的に追跡します。
6 *
7 * @param string $url 取得するウェブページのURL。
8 * @return string|false 成功した場合はウェブページのコンテンツ、失敗した場合はfalse。
9 */
10function fetchWebContent(string $url): string|false
11{
12    // cURLセッションを初期化します
13    $ch = curl_init();
14
15    // cURLオプションを設定します
16
17    // 1. 取得するURLを指定
18    curl_setopt($ch, CURLOPT_URL, $url);
19
20    // 2. 明示的にHTTP GETリクエストを使用するように設定します。
21    //    これは通常デフォルトの動作ですが、他のHTTPメソッドと区別するために設定されることがあります。
22    curl_setopt($ch, CURLOPT_HTTPGET, true);
23
24    // 3. HTTPリダイレクト（例: Locationヘッダーによる転送）を自動的に追跡するように設定します。
25    //    ウェブサイトが別のURLへ誘導する場合に、自動的に新しいURLにアクセスし直します。
26    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
27
28    // 4. curl_exec()の実行結果を文字列として返すように設定します。
29    //    これを設定しないと、結果が直接出力されます。
30    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
31
32    // cURLセッションを実行し、ウェブコンテンツを取得します
33    $response = curl_exec($ch);
34
35    // エラーが発生したかチェックします
36    if (curl_errno($ch)) {
37        // エラーメッセージを表示し、falseを返します
38        echo 'cURLエラー: ' . curl_error($ch) . PHP_EOL;
39        $response = false;
40    }
41
42    // cURLセッションを閉じ、リソースを解放します
43    curl_close($ch);
44
45    return $response;
46}
47
48// --- 関数利用例 ---
49// 実際に存在するURLに置き換えて試してください。
50// 例えば、GoogleのURLはHTTPSにリダイレクトするため、CURLOPT_FOLLOWLOCATIONの効果を確認できます。
51$targetUrl = 'http://www.google.com';
52
53echo "URL: " . $targetUrl . " からコンテンツを取得中..." . PHP_EOL;
54
55$content = fetchWebContent($targetUrl);
56
57if ($content !== false) {
58    echo "--- 取得したコンテンツの一部 ---" . PHP_EOL;
59    // 取得したコンテンツの最初の500文字のみを表示します
60    echo substr($content, 0, 500) . "..." . PHP_EOL;
61    echo "コンテンツの取得に成功しました。" . PHP_EOL;
62} else {
63    echo "コンテンツの取得に失敗しました。" . PHP_EOL;
64}
65
66echo PHP_EOL;
67
68// 別のURLでのテスト例 (存在しないURLの場合)
69$nonExistentUrl = 'https://this-is-a-non-existent-domain-12345.com/';
70echo "URL: " . $nonExistentUrl . " からコンテンツを取得中..." . PHP_EOL;
71
72$contentNonExistent = fetchWebContent($nonExistentUrl);
73
74if ($contentNonExistent !== false) {
75    echo "--- 取得したコンテンツの一部 ---" . PHP_EOL;
76    echo substr($contentNonExistent, 0, 500) . "..." . PHP_EOL;
77    echo "コンテンツの取得に成功しました。" . PHP_EOL;
78} else {
79    echo "コンテンツの取得に失敗しました。" . PHP_EOL;
80}

このサンプルコードは、PHPのcURLライブラリを利用して、指定されたURLからウェブコンテンツを効率的に取得する方法を示しています。fetchWebContent関数は、取得したいウェブページのURLを引数として受け取り、成功した場合はそのコンテンツを文字列として、失敗した場合はfalseを返します。

関数内では、まずcurl_init()でcURLセッションを初期化し、各種オプションを設定しています。CURLOPT_URLで取得対象のURLを設定した後、CURLOPT_HTTPGETをtrueにすることで、明示的にHTTP GETリクエストを使用するように指定しています。これは通常、デフォルトの動作ですが、他のHTTPメソッドと区別する場合に役立ちます。

特に重要なのはCURLOPT_FOLLOWLOCATIONオプションです。これをtrueに設定すると、アクセスしたウェブサイトがHTTPリダイレクト（例: Locationヘッダーによる転送）を指示した場合に、cURLが自動的に新しいURLへ追跡してアクセスし直します。これにより、元のURLが一時的または永続的に移動していても、最終的なウェブコンテンツを取得することが可能になります。また、CURLOPT_RETURNTRANSFERをtrueに設定することで、curl_exec()の実行結果を直接出力するのではなく、文字列として変数に格納できるようになります。

これらの設定後、curl_exec()でリクエストを実行し、curl_errno()でエラーがないかを確認します。エラーが発生した場合はエラーメッセージを表示し、最後にcurl_close()でcURLセッションを閉じ、使用したリソースを解放します。このコードは、ウェブコンテンツの取得において、リダイレクト処理を自動化し、安定したデータ取得を実現するための基本的な手法を提供しています。