Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

CURLOPT_SHARE定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

CURLOPT_SHARE定数は、PHPのcURL拡張機能において、複数のcURL転送間で特定の情報やリソースを共有するために使用する定数です。cURLは、ウェブサーバーとのデータ送受信など、ネットワークを介した通信を行うための非常に強力な機能を提供します。

この定数は、curl_setopt()関数にオプションとして渡すことで使用します。具体的には、curl_setopt($ch, CURLOPT_SHARE, $sh)のように記述し、第二引数にCURLOPT_SHAREを指定し、第三引数にはCURLSH型の共有ハンドルを渡します。この共有ハンドルは、curl_share_init()関数によって作成され、共有するリソースを管理する役割を担います。

CURLOPT_SHAREを活用することで、異なるcURLハンドル(個々の通信処理を管理するオブジェクト)の間で、DNSキャッシュ、HTTP認証情報、SSLセッションID、クッキーなどの情報を効率的に共有することが可能になります。これにより、例えば同じドメインに対して複数のHTTPリクエストを発行する際に、毎回DNS解決を行ったり、認証情報を再送信したりする無駄を省くことができます。結果として、ネットワーク通信の効率が向上し、アプリケーションのパフォーマンスを高める効果が期待できます。

システム開発において、複数のネットワーク通信を伴う処理を実装する際には、この共有機能を適切に利用することで、システム全体の負荷を軽減し、応答速度を向上させることが可能です。共有ハンドルは、使用後にcurl_share_close()関数で適切に解放する必要があります。

構文(syntax)

1<?php
2
3$ch = curl_init();
4$sh = curl_share_init();
5curl_setopt($ch, CURLOPT_SHARE, $sh);
6
7?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP: CURLOPT_FILEでファイル保存する

1<?php
2
3/**
4 * 複数のURLからコンテンツを取得し、それぞれをファイルに保存します。
5 * この際、CURLOPT_SHAREオプションを使用してcURLセッション間でリソース(例: クッキー)を共有し、
6 * CURLOPT_FILEオプションを使用して取得したコンテンツをファイルに直接書き込みます。
7 *
8 * @param array $urlsAndFiles 連想配列で、キーに取得するURL、値に保存するファイル名を指定します。
9 *                            例: ['https://example.com' => 'example_output.html', ...]
10 */
11function fetchUrlsWithSharedResourceAndSaveToFile(array $urlsAndFiles): void
12{
13    // 共有cURLハンドルを初期化します。
14    // 複数のcURLリクエスト間でクッキーなどのリソースを共有するために使われます。
15    $shareHandle = curl_share_init();
16    if (!$shareHandle) {
17        echo "エラー: cURL共有ハンドルの初期化に失敗しました。\n";
18        return;
19    }
20
21    // 共有するリソースとしてクッキーを設定します。
22    // これにより、複数のリクエストで同じセッション情報(クッキー)が利用されます。
23    curl_share_setopt($shareHandle, CURL_SHOPT_SHARE, CURL_SH_COOKIE);
24
25    $curlHandles = []; // 各URL用のcURLハンドルの配列
26    $filePointers = []; // 各出力ファイル用のファイルポインタの配列
27
28    foreach ($urlsAndFiles as $url => $outputFileName) {
29        // 出力用のファイルを書き込みモードでオープンします。
30        $fp = fopen($outputFileName, 'w+');
31        if (!$fp) {
32            echo "エラー: ファイル '{$outputFileName}' を開けませんでした。\n";
33            continue; // 次のURLへ
34        }
35        $filePointers[] = $fp; // 後で閉じるためにポインタを保持
36
37        // cURLハンドルを初期化します。
38        $ch = curl_init($url);
39        if (!$ch) {
40            echo "エラー: URL '{$url}' のcURLハンドル初期化に失敗しました。\n";
41            fclose($fp);
42            continue; // 次のURLへ
43        }
44
45        // cURLオプションを設定します。
46
47        // CURLOPT_SHAREオプションに共有cURLハンドルを渡します。
48        // これにより、このリクエストは上記で設定した共有リソース(クッキー)を利用します。
49        curl_setopt($ch, CURLOPT_SHARE, $shareHandle);
50
51        // CURLOPT_FILEオプションにファイルポインタを渡します。
52        // 取得したコンテンツは標準出力ではなく、このファイルに直接書き込まれます。
53        curl_setopt($ch, CURLOPT_FILE, $fp);
54
55        // リダイレクトを自動的に追跡します。
56        curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
57
58        // SSL証明書の検証を無効にします。(開発環境向け。本番環境では推奨されません。)
59        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
60        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
61
62        $curlHandles[$url] = $ch; // 後で実行・閉じるためにハンドルを保持
63    }
64
65    // 各cURLリクエストを順次実行します。
66    foreach ($curlHandles as $url => $ch) {
67        $outputFileName = $urlsAndFiles[$url]; // 対応するファイル名を取得
68        echo "URL '{$url}' からコンテンツを取得し、'{$outputFileName}' に保存しています...\n";
69
70        curl_exec($ch);
71
72        if (curl_errno($ch)) {
73            echo "エラー: URL '{$url}' のcURLリクエスト中にエラーが発生しました: " . curl_error($ch) . "\n";
74        } else {
75            echo "成功: URL '{$url}' のコンテンツを '{$outputFileName}' に保存しました。\n";
76        }
77    }
78
79    // 使用したリソースを解放します。
80    foreach ($curlHandles as $ch) {
81        curl_close($ch);
82    }
83    foreach ($filePointers as $fp) {
84        fclose($fp);
85    }
86    curl_share_close($shareHandle);
87
88    echo "すべての操作が完了し、リソースが解放されました。\n";
89}
90
91// --- 使用例 ---
92// ここでは、PHPの公式サイトと、一般的なexample.comからデータを取得します。
93// 実行すると、スクリプトと同じディレクトリに 'php_net_output.html' と 'example_com_output.html' が生成されます。
94$targetUrlsAndFiles = [
95    'https://www.php.net' => 'php_net_output.html',
96    'https://example.com' => 'example_com_output.html',
97];
98
99// 関数を実行して、上記URLからコンテンツを取得しファイルに保存します。
100fetchUrlsWithSharedResourceAndSaveToFile($targetUrlsAndFiles);
101
102// // オプション: 生成されたファイルを削除するには、以下の行のコメントを解除してください。
103// unlink('php_net_output.html');
104// unlink('example_com_output.html');
105
106?>

このPHPサンプルコードは、複数のURLからウェブコンテンツを取得し、それぞれ指定されたファイルに保存する方法を示しています。特に、複数のcURLリクエスト間でリソースを共有するCURLOPT_SHAREオプションと、取得したコンテンツを直接ファイルに書き込むCURLOPT_FILEオプションの利用方法がポイントです。

関数fetchUrlsWithSharedResourceAndSaveToFileは、取得するURLと保存ファイル名の連想配列を引数に取ります。まず、curl_share_init()で共有cURLハンドルを作成し、curl_share_setopt()でクッキーなどのリソースを共有する設定を行います。これにより、複数のリクエストで同じセッション情報が利用できます。

次に、各URLに対応する個別のcURLハンドルを初期化し、curl_setopt()を使用してCURLOPT_SHAREオプションに共有ハンドルを、CURLOPT_FILEオプションにはコンテンツを書き込むためのファイルポインタを設定します。これにより、ウェブから取得したデータは標準出力ではなく、直接指定されたファイルに効率的に保存されます。全てのcURLリクエストを実行後、使用したcURLハンドル、ファイルポインタ、そして共有ハンドルを適切に解放します。引数$urlsAndFilesは、取得元のURLと保存先ファイル名の対応を指定し、戻り値voidは関数が特定の値を返さないことを示しています。

CURLOPT_SHAREオプションは、複数のcURLリクエスト間でクッキーなどのリソースを共有するために使用します。これにより、セッション情報を効率的に引き継ぐことが可能です。共有ハンドルは必ずcurl_share_init()で初期化し、処理終了後はcurl_share_close()で確実に解放してください。CURLOPT_FILEオプションを使うと、取得したコンテンツを直接ファイルへ書き込めるため、大量のデータを扱う際にメモリ使用量を抑えられます。ファイルポインタはfopen()で開いたら、処理の最後に必ずfclose()で閉じる必要があります。また、サンプルコードにあるCURLOPT_SSL_VERIFYPEERなどをfalseにする設定は、本番環境ではセキュリティ上の問題を引き起こすため、開発時のみに限定し、実際の運用では適切な検証を行うことが重要です。すべてのcURLハンドルもcurl_close()で確実に解放しましょう。エラーハンドリングも忘れずに行ってください。

PHP cURLでリダイレクト追従する

1<?php
2
3/**
4 * 指定されたURLにcURLリクエストを送信し、その結果を返します。
5 * HTTPリダイレクトが発生した場合、CURLOPT_FOLLOWLOCATION オプションにより自動的にその先に追従します。
6 *
7 * @param string $url リクエストを送信するURL。
8 * @return string|false リクエストの応答ボディ(文字列)、またはエラーが発生した場合は false。
9 */
10function fetchUrlContentWithFollowLocation(string $url): string|false
11{
12    // 1. cURLセッションを初期化します。
13    // cURLはHTTPリクエストを送信するためのPHPの拡張機能です。
14    $ch = curl_init();
15
16    // 初期化に失敗した場合はエラーログを出力し、falseを返します。
17    if ($ch === false) {
18        error_log('cURLセッションの初期化に失敗しました。');
19        return false;
20    }
21
22    // 2. cURLオプションを設定します。
23    // curl_setopt() を使用して、リクエストの振る舞いを細かく制御します。
24
25    // リクエストを送信するURLを設定します。
26    curl_setopt($ch, CURLOPT_URL, $url);
27
28    // 応答をブラウザに直接出力せず、文字列として取得するように設定します。
29    // これにより、$response 変数に結果を格納できます。
30    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
31
32    // ★キーワードに関連するオプション★
33    // HTTPリダイレクト (例: 301 Moved Permanently, 302 Found) が発生した場合に、
34    // cURLが自動的にそのリダイレクト先に追従するように設定します。
35    // これがないと、リダイレクト先のコンテンツではなく、リダイレクトを指示する応答が返されることがあります。
36    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
37
38    // リクエストのタイムアウト時間を秒単位で設定します。
39    // 長すぎるタイムアウトはプログラムの停止時間を長くし、短すぎると通信環境が悪い場合に失敗しやすくなります。
40    curl_setopt($ch, CURLOPT_TIMEOUT, 30); // 30秒
41
42    // リクエストのUser-Agentヘッダを設定します。
43    // 多くのWebサイトは、この情報を使用して、リクエスト元のアプリケーションを識別します。
44    curl_setopt($ch, CURLOPT_USERAGENT, 'PHP cURL Example Bot/1.0');
45
46    // 3. cURLリクエストを実行します。
47    $response = curl_exec($ch);
48
49    // 4. エラーチェックを行います。
50    // curl_errno() は直前のcURL操作で発生したエラーコードを返します。
51    // エラーが発生した場合は、curl_error() でエラーメッセージを取得できます。
52    if (curl_errno($ch)) {
53        $error_msg = curl_error($ch);
54        error_log("cURLリクエストエラー: {$error_msg} (URL: {$url})");
55        curl_close($ch); // エラーの場合もセッションを閉じます。
56        return false;
57    }
58
59    // 5. cURLセッションを閉じ、リソースを解放します。
60    curl_close($ch);
61
62    return $response;
63}
64
65// サンプルコードの実行部分
66// 実際にリダイレクトが発生するURLの例として、httpbin.org を使用します。
67// このURLは最終的に https://www.example.com にリダイレクトされます。
68$targetUrl = 'https://httpbin.org/redirect-to?url=https://www.example.com';
69
70echo "--- cURL リクエスト開始 ---\n";
71echo "対象URL: " . $targetUrl . "\n";
72echo "CURLOPT_FOLLOWLOCATION が有効なため、リダイレクトに追従します。\n";
73
74$content = fetchUrlContentWithFollowLocation($targetUrl);
75
76if ($content !== false) {
77    echo "\n--- 成功: 取得したコンテンツの一部 ---\n";
78    // 取得したコンテンツの最初の500文字のみ表示
79    echo htmlspecialchars(substr($content, 0, 500)) . "...\n";
80    echo "(コンテンツの詳細は省略されました)\n";
81    echo "--- 取得完了 ---\n";
82} else {
83    echo "\n--- 失敗: cURLリクエストの実行中にエラーが発生しました。---\n";
84}
85
86?>

このPHPコードは、ウェブサイトのコンテンツを取得するために「cURL」という拡張機能を利用する方法を解説しています。

まず、fetchUrlContentWithFollowLocation関数は、指定されたURLへHTTPリクエストを送信し、その応答内容を文字列として返します。もし通信エラーが発生した場合はfalseを返します。

この関数では、curl_init()でcURLセッションを初期化し、curl_setopt()を使って様々な設定を行っています。特に注目すべきはCURLOPT_FOLLOWLOCATIONオプションで、これをtrueに設定することで、ウェブサイトが「別のページへ移動してください」という指示(HTTPリダイレクト)を出した場合でも、cURLが自動的にその新しいURLへ追従してコンテンツを取得するようになります。これにより、リダイレクト元のページではなく、最終的に表示されるべきコンテンツを確実に入手できます。

その他の設定として、CURLOPT_URLでリクエスト先URL、CURLOPT_RETURNTRANSFERで取得した内容を文字列として変数に格納する設定、CURLOPT_TIMEOUTでタイムアウト時間、CURLOPT_USERAGENTでリクエスト元の情報を設定しています。

設定後、curl_exec()で実際にリクエストを実行し、curl_errno()やcurl_error()でエラーがないかを確認します。最後に、curl_close()でcURLセッションを終了し、リソースを解放します。この一連の処理により、HTTPリダイレクトに対応した安定したウェブコンテンツの取得が可能です。

このサンプルコードで利用しているCURLOPT_FOLLOWLOCATIONは、HTTPリダイレクトに自動追従する便利な機能ですが、予期せぬ無限ループや意図しないURLへの追従を防ぐため、CURLOPT_MAXREDIRSで最大追従回数を必ず設定してください。外部URLを扱う際は、追従先のURLが信頼できるか常に検証し、セキュリティリスクに十分注意が必要です。また、cURLセッションは処理が完了したら、エラー発生時も含めcurl_close()で確実にリソースを解放することが、メモリリーク防止のために不可欠です。タイムアウト設定も、ネットワーク状況に応じて適切な値に調整することで、より安定した動作が期待できます。

関連コンテンツ

関連IT用語

関連プログラミング言語