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

Copy
1<?php
2
3/**
4 * 指定されたURLへHTTP POSTリクエストを送信する関数。
5 *
6 * @param string $url POSTリクエストの送信先URL。
7 * @param array $postData 送信するPOSTデータ（キーと値の連想配列）。
8 * @return string|false 成功した場合はサーバーからの応答文字列、失敗した場合はfalse。
9 */
10function sendPostRequest(string $url, array $postData): string|false
11{
12    // cURLセッションを初期化します。
13    $ch = curl_init();
14
15    // cURLオプションを設定します。
16    // リクエストを送信するURLを指定します。
17    curl_setopt($ch, CURLOPT_URL, $url);
18    // HTTP POSTリクエストを有効にします。
19    curl_setopt($ch, CURLOPT_POST, true);
20    // 送信するPOSTデータを指定します。http_build_queryで配列をURLエンコードされた文字列に変換します。
21    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData));
22    // サーバーからの応答を直接出力せず、文字列として取得するように設定します。
23    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
24    // SSL証明書の検証を無効にする（開発・テスト環境向け。本番環境では適切に設定するべきです。）
25    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
26    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
27
28
29    // cURLリクエストを実行し、応答を取得します。
30    $response = curl_exec($ch);
31
32    // cURLリクエスト中にエラーが発生したか確認します。
33    if (curl_errno($ch)) {
34        // エラーが発生した場合は、エラーメッセージを出力し、falseを返します。
35        echo 'cURLエラー: ' . curl_error($ch) . "\n";
36        $response = false;
37    }
38
39    // cURLセッションを閉じます。
40    curl_close($ch);
41
42    return $response;
43}
44
45// --- サンプル使用例 ---
46// テスト用のPOSTリクエスト受信サービス（例: httpbin.org）のURL
47$targetUrl = 'https://httpbin.org/post';
48
49// 送信するPOSTデータ
50$dataToSend = [
51    'name' => '山田 太郎',
52    'email' => 'taro.yamada@example.com',
53    'message' => 'これはテストメッセージです。',
54];
55
56echo "POSTリクエストを {$targetUrl} へ送信中...\n";
57
58// 関数を呼び出してPOSTリクエストを送信し、結果を取得します。
59$result = sendPostRequest($targetUrl, $dataToSend);
60
61if ($result !== false) {
62    // 成功した場合、サーバーからの応答を表示します。
63    echo "--- サーバーからの応答 ---\n";
64    echo $result;
65    echo "\n--------------------------\n";
66} else {
67    // 失敗した場合のメッセージを表示します。
68    echo "POSTリクエストの送信に失敗しました。\n";
69}
70
71?>

このサンプルコードは、PHPを使って外部のウェブサーバーへHTTP POSTリクエストを送信する基本的な方法を示しています。sendPostRequest関数は、データを送信したいURLと、送信するデータ（キーと値のペアを連想配列で表現したもの）を引数として受け取ります。

関数内では、まずcurl_init()でcURL通信を始めるための準備を行います。次にcurl_setopt()を使って通信に関する詳細な設定を行います。CURLOPT_URLでリクエストの送信先URLを指定し、特にCURLOPT_POSTをtrueに設定することで、データをサーバーに送るPOST形式のリクエストを有効にします。CURLOPT_POSTFIELDSには、http_build_query関数で連想配列からURLエンコードされた文字列に変換したPOSTデータを設定します。

また、CURLOPT_RETURNTRANSFERをtrueに設定すると、サーバーからの応答をプログラム内で文字列として受け取ることができ、直接画面に出力されなくなります。CURLOPT_SSL_VERIFYPEERとCURLOPT_SSL_VERIFYHOSTは、開発環境などでSSL証明書の検証を一時的に無効にするための設定です。これらの設定後、curl_exec()で実際にリクエストが実行されます。エラーがなければ、サーバーからの応答文字列が返り値として得られ、最後にcurl_close()で通信を終了します。この関数は、成功した場合はサーバーの応答文字列を、失敗した場合はfalseを返します。

Copy
1<?php
2
3/**
4 * HTTP POSTリクエストを送信する関数です。
5 * CURLOPT_POSTFIELDS を使用して、POSTするデータを設定します。
6 *
7 * @param string $url POSTリクエストの送信先URL
8 * @param array $data POSTするデータ（連想配列）。自動的にURLエンコードされます。
9 * @return string|false レスポンスボディ、またはリクエストが失敗した場合は false を返します。
10 */
11function sendPostRequest(string $url, array $data): string|false
12{
13    // cURLセッションを初期化します。
14    $ch = curl_init();
15
16    // cURLオプションを設定します。
17    // リクエストの送信先URLを設定します。
18    curl_setopt($ch, CURLOPT_URL, $url);
19
20    // このリクエストがPOSTリクエストであることを指定します。
21    curl_setopt($ch, CURLOPT_POST, true);
22
23    // POSTするデータを設定します。
24    // 配列で渡すと、cURLが自動的に "application/x-www-form-urlencoded" 形式にエンコードします。
25    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
26
27    // curl_exec() がレスポンスを文字列として返すように設定します。
28    // これを設定しないと、レスポンスが直接出力されます。
29    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
30
31    // cURLセッションを実行し、レスポンスを取得します。
32    $response = curl_exec($ch);
33
34    // エラーが発生した場合はエラーメッセージを表示します。
35    if (curl_errno($ch)) {
36        error_log('cURL エラー: ' . curl_error($ch));
37        $response = false;
38    }
39
40    // cURLセッションを閉じます。リソースを解放します。
41    curl_close($ch);
42
43    return $response;
44}
45
46// --- 使用例 ---
47// テスト用のPOSTエンドポイント。
48// ここにリクエストを送ると、送ったデータがJSON形式で返ってきます。
49$targetUrl = 'https://httpbin.org/post';
50
51// POSTするデータ（連想配列）
52$postData = [
53    'username' => 'php_user',
54    'message' => 'Hello from PHP cURL!',
55    'version' => 8
56];
57
58echo "--- HTTP POSTリクエストの送信 ---\n";
59echo "送信先URL: " . $targetUrl . "\n";
60echo "送信データ: " . json_encode($postData, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) . "\n\n";
61
62// sendPostRequest 関数を呼び出してPOSTリクエストを送信します。
63$result = sendPostRequest($targetUrl, $postData);
64
65// レスポンスが正常に取得できたかを確認します。
66if ($result !== false) {
67    echo "--- レスポンスボディ ---\n";
68    echo $result . "\n";
69} else {
70    echo "POSTリクエストの送信に失敗しました。\n";
71}
72
73?>

このコードは、PHPのcURLライブラリを活用してHTTP POSTリクエストを送信する方法を示しています。中心となるsendPostRequest関数は、指定されたURLへデータをPOST送信し、その結果を受け取るために作られています。

関数内で特に注目すべきは、CURLOPT_POSTFIELDS定数を使用した設定です。この定数にPOSTしたいデータを配列形式で渡すと、cURLが自動的にそのデータをURLエンコード（application/x-www-form-urlencoded形式）し、リクエストの本体（ボディ）に含めてサーバーに送信してくれます。これにより、手動でデータを整形する手間が省け、簡単にフォームデータなどを送信できます。

その他にも、CURLOPT_URLでリクエストの送信先URLを指定し、CURLOPT_POSTをtrueに設定することで、このリクエストがPOSTメソッドであることをcURLに伝えます。また、CURLOPT_RETURNTRANSFERをtrueに設定することで、curl_exec()関数がサーバーからのレスポンスを直接画面に出力するのではなく、PHPの変数に文字列として格納できるようにしています。

sendPostRequest関数は、POSTリクエストの送信先URL（文字列）と、送信したいデータ（連想配列）の二つを引数として受け取ります。処理が成功した場合は、サーバーからのレスポンスボディを文字列として返し、何らかの理由でリクエストが失敗した場合はfalseを返します。この関数を使うことで、Webサービスへのデータ登録や更新など、様々なPOST通信を安全かつ簡潔に実装できます。