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

<?php

/**
 * curl_exec を使用してリクエストを実行し、エラー処理を行うサンプル
 *
 * @return void
 */
function executeCurlRequest(): void
{
    // curl ハンドルを初期化
    $ch = curl_init();

    // URLを設定
    curl_setopt($ch, CURLOPT_URL, 'https://example.com');

    // CURLOPT_RETURNTRANSFER を true に設定して、結果を文字列として返すようにする
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    // リクエストを実行し、結果を取得
    $result = curl_exec($ch);

    // エラーが発生した場合の処理
    if ($result === false) {
        echo 'cURL error: ' . curl_error($ch) . PHP_EOL;
    } else {
        // 結果を処理
        echo 'cURL result: ' . $result . PHP_EOL;
    }

    // curl ハンドルを閉じる
    curl_close($ch);
}

// 関数を実行
executeCurlRequest();

curl_exec関数は、PHPのcURL拡張に含まれる関数で、cURLセッションを実行し、サーバーからのレスポンスを取得するために使用します。引数には、curl_init関数などで初期化されたCurlHandleオブジェクトを渡します。このCurlHandleオブジェクトには、リクエスト先のURLやHTTPメソッド、ヘッダーなど、リクエストに関する様々なオプションが設定されています。

curl_exec関数は、通常、サーバーからのレスポンスボディを文字列として返します。もしエラーが発生した場合は、falseを返します。そのため、curl_execの実行後には、戻り値がfalseかどうかをチェックし、エラーハンドリングを行うことが重要です。エラーが発生した場合は、curl_error関数を使用して、具体的なエラーメッセージを取得できます。

サンプルコードでは、まずcurl_init関数でcURLセッションを初期化し、curl_setopt関数でリクエスト先のURLと、レスポンスを文字列として受け取るためのオプションCURLOPT_RETURNTRANSFERを設定しています。curl_exec関数を実行後、戻り値がfalseかどうかを判定し、エラーが発生した場合はcurl_error関数でエラーメッセージを表示します。エラーが発生しなかった場合は、取得したレスポンスを表示します。最後に、curl_close関数でcURLセッションをクローズします。このサンプルは、curl_exec関数を使用した基本的なリクエストの実行方法と、エラー処理の方法を示しています。

<?php

/**
 * 指定されたURLからデータを取得し、タイムアウトを設定する例
 *
 * @param string $url 取得するURL
 * @param int $timeout タイムアウト時間（秒）
 * @return string|false 成功時はデータ、失敗時はfalse
 */
function fetch_data_with_timeout(string $url, int $timeout = 10): string|false
{
    // cURLハンドラを初期化
    $ch = curl_init($url);

    if ($ch === false) {
        error_log("cURLの初期化に失敗しました。");
        return false;
    }

    // オプションを設定
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // データを文字列として返す
    curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);    // タイムアウト時間を設定

    // リクエストを実行
    $result = curl_exec($ch);

    // エラーが発生した場合
    if ($result === false) {
        error_log("cURLエラー: " . curl_error($ch));
    }

    // cURLハンドラを閉じる
    curl_close($ch);

    return $result;
}

// 使用例
$url = 'https://example.com';
$data = fetch_data_with_timeout($url, 5); // タイムアウトを5秒に設定

if ($data !== false) {
    echo "データ取得成功:\n";
    echo substr($data, 0, 200) . "...\n"; // 最初の200文字だけ表示
} else {
    echo "データ取得失敗。\n";
}

?>

curl_exec関数は、PHPでHTTPリクエストを送信し、レスポンスを取得するために使用されます。この関数は、初期化されたcURLハンドラ（CurlHandle $handle）を引数に取り、指定されたURLにリクエストを送信します。

サンプルコードでは、fetch_data_with_timeout関数内でcurl_execを使用し、タイムアウト時間を設定する方法を示しています。まず、curl_init関数でcURLハンドラを初期化し、curl_setopt関数でオプションを設定します。CURLOPT_RETURNTRANSFERオプションをtrueに設定することで、curl_execがレスポンスを文字列として返すようにします。CURLOPT_TIMEOUTオプションでタイムアウト時間を秒単位で設定します。

curl_exec($ch)を実行すると、指定されたURLにリクエストが送信され、レスポンスが取得されます。成功した場合はレスポンスの文字列が返され、失敗した場合はfalseが返されます。エラーが発生した場合は、curl_error関数でエラーメッセージを取得し、ログに出力します。最後に、curl_close関数でcURLハンドラを閉じます。

この例では、example.comからデータを取得し、タイムアウトを5秒に設定しています。取得したデータがfalseでない場合、データの最初の200文字を表示します。curl_exec関数を使うことで、タイムアウトを設定し、安全に外部のWebサイトからデータを取得することができます。