【PHP8.x】curl_setopt_array関数の使い方

Copy
1<?php
2
3/**
4 * curl_setopt_array を使用してHTTP GETリクエストを実行するサンプルコード。
5 *
6 * このスクリプトは、指定されたURLに対してGETリクエストを送信し、
7 * レスポンスを表示します。エラーハンドリングも含まれています。
8 * curl_setopt_array が期待通りに動作しない場合の原因として、
9 * cURLセッションの初期化失敗や、オプション設定後の実行時のエラーが考えられます。
10 *
11 * この例では、公開されているJSON Placeholder APIを利用します。
12 */
13
14// ターゲットURL
15$url = "https://jsonplaceholder.typicode.com/posts/1";
16
17// cURLセッションを初期化
18// curl_init() は CurlHandle オブジェクト、または失敗時に false を返します。
19$ch = curl_init();
20
21if ($ch === false) {
22    // cURLセッションの初期化に失敗した場合のエラー処理
23    echo "エラー: cURLセッションの初期化に失敗しました。\n";
24    exit;
25}
26
27// curl_setopt_array() に渡すオプション配列を定義
28// キーは CURLOPT_XXX 定数、値はそれぞれのオプション設定です。
29$options = [
30    CURLOPT_URL            => $url,          // リクエストを送信するURL
31    CURLOPT_RETURNTRANSFER => true,          // 転送結果を文字列で取得する (出力しない)
32    CURLOPT_HEADER         => false,         // レスポンスヘッダを含めない
33    CURLOPT_FOLLOWLOCATION => true,          // HTTPリダイレクトを追跡する
34    CURLOPT_TIMEOUT        => 30,            // 最大実行時間 (秒)
35    CURLOPT_SSL_VERIFYPEER => true,          // SSL証明書の検証を有効にする
36    CURLOPT_SSL_VERIFYHOST => 2,             // ホスト名の検証レベル (PHP 5.4.0以降は2を指定)
37];
38
39// curl_setopt_array() を使用して複数のオプションを一度に設定
40// すべてのオプションが正常に設定された場合に true を返します。
41if (curl_setopt_array($ch, $options)) {
42    echo "cURLオプションの設定に成功しました。\n";
43
44    // cURLセッションを実行し、結果を取得
45    // 成功した場合、CURLOPT_RETURNTRANSFER が true なので結果文字列を返します。
46    // 失敗した場合、false を返します。
47    $response = curl_exec($ch);
48
49    // cURL実行後のエラーチェック
50    if (curl_errno($ch)) {
51        // エラーが発生した場合、エラーコードとエラーメッセージを表示
52        echo "cURL実行エラー (" . curl_errno($ch) . "): " . curl_error($ch) . "\n";
53    } else {
54        // 成功した場合、取得したレスポンスを表示
55        echo "--- レスポンス開始 ---\n";
56        echo $response;
57        echo "\n--- レスポンス終了 ---\n";
58    }
59} else {
60    // オプション設定に失敗した場合のエラー処理
61    // この関数は、通常、無効なオプションキーが含まれている場合に失敗します。
62    echo "エラー: cURLオプションの設定に失敗しました。\n";
63}
64
65// cURLセッションを閉じる (リソースを解放)
66curl_close($ch);
67
68?>

curl_setopt_array関数は、PHPのcURL拡張機能の一部で、HTTPリクエストなどを行うための複数のcURLオプションを一度に設定するために使用されます。

この関数は、二つの引数を取ります。一つ目は、curl_init()関数で初期化されたcURLセッションのハンドル（CurlHandleオブジェクト）です。二つ目は、設定したいcURLオプションをキーと値のペアで指定する配列です。例えば、リクエスト先のURLはCURLOPT_URL、転送結果を文字列で受け取るかはCURLOPT_RETURNTRANSFERなどの定数で指定します。この関数は、全てのオプションが正常に設定された場合にtrueを返し、一つでも設定に失敗した場合はfalseを返します。オプションのキーが無効である場合などに失敗することがあります。

提示されたサンプルコードでは、まずcurl_init()でcURLセッションを開始し、その結果が成功したかを確認しています。次に、リクエスト先のURLやレスポンスの取得方法など、必要なオプションを$optionsという配列にまとめて定義しています。そして、この$options配列をcurl_setopt_array()に渡し、一度に複数の設定を行っています。設定が成功した場合、curl_exec()で実際にHTTP GETリクエストを実行し、その結果を表示します。curl_init()の失敗、curl_setopt_array()での設定失敗、またはcurl_exec()の実行エラーなど、それぞれの段階でエラーを丁寧にチェックし、適切にメッセージを出力している点が重要です。最後にcurl_close()でセッションを閉じ、リソースを解放しています。このように複数のオプションを一括で設定することで、コードが簡潔になり、効率的にcURLリクエストを扱えるようになります。

Copy
1<?php
2
3/**
4 * curl_setopt_array を使用してHTTP POSTリクエストを送信します。
5 *
6 * @param string $url POSTリクエストを送信するターゲットURL。
7 * @param array $postData 送信するPOSTデータの連想配列。
8 * @return string|false リクエストが成功した場合はレスポンスの内容、失敗した場合はfalse。
9 */
10function sendCurlPostRequest(string $url, array $postData)
11{
12    // cURLセッションを初期化します。
13    $ch = curl_init();
14
15    if ($ch === false) {
16        error_log('cURLセッションの初期化に失敗しました。');
17        return false;
18    }
19
20    // POSTデータをURLエンコードされた文字列に変換します。
21    // 例: ['name' => 'John Doe', 'age' => 30] は "name=John+Doe&age=30" になります。
22    $postFields = http_build_query($postData);
23
24    // cURLオプションを連想配列で定義します。
25    $options = [
26        CURLOPT_URL            => $url,            // リクエスト先のURL
27        CURLOPT_POST           => true,            // HTTP POSTリクエストを有効にします。
28        CURLOPT_POSTFIELDS     => $postFields,     // 送信するPOSTデータ。
29        CURLOPT_RETURNTRANSFER => true,            // 転送結果を文字列として返します（画面出力はしません）。
30        CURLOPT_HEADER         => false,           // レスポンスヘッダをレスポンスに含めません。
31        CURLOPT_FAILONERROR    => true,            // HTTPステータスコードが400以上の場合にエラーとします。
32        CURLOPT_TIMEOUT        => 30,              // 最大実行時間を30秒に設定します。
33    ];
34
35    // curl_setopt_array を使用して、定義した複数のオプションを一括で設定します。
36    // 成功した場合は true、失敗した場合は false を返します。
37    if (!curl_setopt_array($ch, $options)) {
38        error_log('cURLオプションの設定に失敗しました: ' . curl_error($ch));
39        curl_close($ch);
40        return false;
41    }
42
43    // cURLセッションを実行し、レスポンスを取得します。
44    $response = curl_exec($ch);
45
46    // cURL実行中にエラーが発生したか確認します。
47    if (curl_errno($ch)) {
48        error_log('cURLエラーが発生しました: ' . curl_error($ch));
49        $response = false;
50    }
51
52    // cURLセッションを閉じ、リソースを解放します。
53    curl_close($ch);
54
55    return $response;
56}
57
58// --- サンプル使用例 ---
59// テスト用のPOSTリクエストを受け付けるURL (例: httpbin.org はテストに便利です)
60$targetUrl = 'https://httpbin.org/post';
61
62// 送信するPOSTデータ
63$dataToSend = [
64    'username' => 'testuser',
65    'password' => 'securepassword123',
66    'email'    => 'test@example.com',
67];
68
69echo "POSTリクエストを {$targetUrl} へ送信中...\n";
70
71// 関数を呼び出してPOSTリクエストを送信します。
72$result = sendCurlPostRequest($targetUrl, $dataToSend);
73
74if ($result !== false) {
75    echo "レスポンス:\n";
76    // レスポンスがJSON形式の場合、デコードして整形すると見やすくなります。
77    $decodedResponse = json_decode($result, true);
78    if (json_last_error() === JSON_ERROR_NONE) {
79        print_r($decodedResponse);
80    } else {
81        echo $result . "\n";
82    }
83} else {
84    echo "POSTリクエストの送信に失敗しました。\n";
85}

curl_setopt_array関数は、PHPのcURL拡張機能において、一度に複数のオプションをcURLセッションに設定するための関数です。個々のオプションをcurl_setopt関数で一つずつ設定する代わりに、オプションのキーと値のペアからなる連想配列を渡すことで、コードをより簡潔にし、可読性を高めることができます。

この関数の第1引数には、curl_init()によって初期化されたcURLセッションハンドルを指定します。これは、どの通信セッションにオプションを設定するかを識別するためのものです。第2引数には、設定したいオプションを連想配列で渡します。例えば、CURLOPT_URLキーにリクエスト先のURLを、CURLOPT_POSTキーにtrueを設定することで、POSTリクエストを指定できます。

戻り値は真偽値（bool）です。指定した全てのオプションが正常に設定できた場合はtrueを返し、いずれかのオプション設定に失敗した場合はfalseを返します。

サンプルコードでは、この関数を用いてPOSTリクエストに必要な設定（URL、POSTメソッドの有効化、送信データ、レスポンスの取得方法など）を$optionsという配列にまとめて定義し、一括でcURLセッションに適用しています。これにより、どのような通信設定が行われているかが一目でわかりやすくなっています。このように、curl_setopt_arrayは、外部APIとの連携など、複雑な通信設定を効率的に管理する際に非常に便利な関数です。