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

Copy
1<?php
2
3/**
4 * CURLOPT_NOBODY を使用して指定されたURLのボディをスキップするサンプル関数。
5 *
6 * この関数はHTTPリクエストを送信しますが、CURLOPT_NOBODY を設定することで、
7 * サーバーから返されるレスポンスボディは取得しません。
8 * 主にリソースの存在確認や、HTTPヘッダー情報のみを効率的に取得したい場合（CURLOPT_HEADERと併用）に使用されます。
9 *
10 * @param string $url 取得するURL
11 * @return bool リクエストが成功し、ボディがスキップされた場合はtrue、それ以外はfalse
12 */
13function checkUrlWithoutBody(string $url): bool
14{
15    // cURLセッションを初期化
16    $ch = curl_init();
17
18    if ($ch === false) {
19        echo "エラー: cURLセッションの初期化に失敗しました。\n";
20        return false;
21    }
22
23    // 取得するURLを設定
24    curl_setopt($ch, CURLOPT_URL, $url);
25
26    // CURLOPT_NOBODY を true に設定することで、HTTPボディは取得されません。
27    // これにより、データ転送量を減らし、高速にリクエストのステータスを確認できます。
28    curl_setopt($ch, CURLOPT_NOBODY, true);
29
30    // curl_exec() の結果を文字列として返すように設定します。
31    // CURLOPT_NOBODY が true の場合、ボディがないため返される文字列は通常空になります。
32    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
33
34    // cURLセッションを実行
35    $response = curl_exec($ch);
36
37    if ($response === false) {
38        // cURL実行中にエラーが発生した場合
39        echo "エラー: cURLリクエストの実行に失敗しました。\n";
40        echo "cURLエラー: " . curl_error($ch) . "\n";
41        curl_close($ch);
42        return false;
43    }
44
45    // HTTPステータスコードを取得
46    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
47
48    // cURLセッションを閉じる
49    curl_close($ch);
50
51    echo "--- リクエスト結果 --- \n";
52    echo "対象URL: " . $url . "\n";
53    echo "HTTPステータスコード: " . $httpCode . "\n";
54    echo "curl_exec() の返り値の長さ（ボディの有無）: " . strlen($response) . "バイト\n";
55
56    // HTTPステータスコードが200番台（成功）かつ、返り値の長さが0であれば、
57    // ボディが正常にスキップされたと判断できます。
58    if ($httpCode >= 200 && $httpCode < 300 && strlen($response) === 0) {
59        echo "メッセージ: CURLOPT_NOBODY が効果的に機能し、ボディは取得されませんでした。\n";
60        return true;
61    } elseif ($httpCode >= 200 && $httpCode < 300) {
62        echo "警告: HTTPリクエストは成功しましたが、curl_exec() の返り値が空ではありませんでした。"
63             . "CURLOPT_NOBODY の設定、またはサーバーの応答を確認してください。\n";
64        return false;
65    } else {
66        echo "エラー: リクエストが失敗しました。HTTPステータスコード: " . $httpCode . "\n";
67        return false;
68    }
69}
70
71// サンプルとしてチェックするURL
72$targetUrl = "https://www.example.com"; // 実際のWebサイトのURLに置き換えてお試しください
73
74// 関数を実行
75$success = checkUrlWithoutBody($targetUrl);
76
77if ($success) {
78    echo "\n✔ URLのチェックが成功しました（ボディなし）。\n";
79} else {
80    echo "\n✖ URLのチェックに失敗しました。\n";
81}
82
83?>

PHPのCURLOPT_NOBODYは、cURL拡張機能でHTTPリクエストを送信する際に使用される定数の一つです。この定数をtrueに設定すると、指定されたURLへのリクエストは行われますが、サーバーから返されるレスポンスのボディ部分を一切取得せずに、ヘッダー情報のみを受け取ります。これにより、データ転送量を大幅に削減し、特に大きなファイルや複雑なページの内容を読み込むことなく、ウェブサイトの存在確認やHTTPステータスコードのみを効率的に取得したい場合に役立ちます。

サンプルコードのcheckUrlWithoutBody関数では、まずcurl_init()でcURLセッションを開始し、curl_setopt()を使って各種設定を行っています。ここでCURLOPT_NOBODYをtrueに設定することで、サーバーからボディデータが転送されないように指示しています。また、CURLOPT_RETURNTRANSFERをtrueに設定することで、curl_exec()の実行結果を文字列として受け取れるようにしていますが、CURLOPT_NOBODYが有効な場合、この文字列は通常空になります。

関数は最終的にcurl_getinfo()で取得したHTTPステータスコードが200番台であり、かつボディが空であることを確認して、リクエストが成功したと判断しtrueを返します。CURLOPT_NOBODY自体には引数や戻り値はありませんが、この関数では引数としてチェックする$urlを受け取り、リクエストの成功・失敗をbool値で返します。このようにCURLOPT_NOBODYを利用することで、ウェブリソースへの軽量なアクセスが可能になります。