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

Copy
1<?php
2
3/**
4 * curl_file_createを使用してファイルをアップロードするサンプル関数
5 *
6 * この関数は、ローカルに一時ファイルを作成し、
7 * curl_file_createでCURLFileオブジェクトを生成して、
8 * httpbin.orgのPOSTエンドポイントにファイルをアップロードします。
9 * 実行後、レスポンス内容を表示し、一時ファイルを削除します。
10 *
11 * @return void
12 */
13function uploadFileExample(): void
14{
15    // アップロード先のURL (受信したリクエスト情報をJSONで返すサービス)
16    $targetUrl = 'https://httpbin.org/post';
17
18    // アップロードするダミーファイルを作成
19    $dummyFilePath = __DIR__ . '/upload_test.txt';
20    $dummyFileContent = 'これはcurl_file_createのテスト用ファイルです。';
21    file_put_contents($dummyFilePath, $dummyFileContent);
22
23    echo "一時ファイルを作成しました: {$dummyFilePath}" . PHP_EOL;
24
25    try {
26        // 1. CURLFileオブジェクトの作成
27        // curl_file_create(ファイルのパス, MIMEタイプ, サーバー側で認識されるファイル名)
28        $cfile = curl_file_create(
29            $dummyFilePath,
30            'text/plain',
31            'sample.txt'
32        );
33
34        // 2. POSTデータの設定
35        // 'file_field' がHTMLの <input type="file" name="file_field"> のnameに相当します。
36        $postData = [
37            'file_field' => $cfile,
38            'user_name' => 'Taro Yamada',
39            'user_id' => '12345',
40        ];
41
42        // 3. cURLセッションの初期化と設定
43        $ch = curl_init();
44        curl_setopt_array($ch, [
45            CURLOPT_URL => $targetUrl,
46            CURLOPT_RETURNTRANSFER => true, // 結果を文字列で返す
47            CURLOPT_POST => true,           // POSTリクエストを指定
48            CURLOPT_POSTFIELDS => $postData,    // POSTデータを設定
49            CURLOPT_SAFE_UPLOAD => true,    // PHP 5.6.0以降ではデフォルトでtrue
50        ]);
51
52        // 4. cURLリクエストの実行
53        echo "ファイルをアップロードしています..." . PHP_EOL;
54        $response = curl_exec($ch);
55
56        // 5. エラーチェック
57        if (curl_errno($ch)) {
58            echo 'cURLエラー: ' . curl_error($ch) . PHP_EOL;
59        } else {
60            // 6. 結果の表示
61            echo "サーバーからのレスポンス:" . PHP_EOL;
62            // httpbin.orgはJSONを返すので、見やすく整形して表示
63            $responseData = json_decode($response, true);
64            echo json_encode($responseData, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) . PHP_EOL;
65        }
66
67        // 7. cURLセッションの終了
68        curl_close($ch);
69
70    } finally {
71        // 8. 作成した一時ファイルを削除
72        if (file_exists($dummyFilePath)) {
73            unlink($dummyFilePath);
74            echo "一時ファイルを削除しました: {$dummyFilePath}" . PHP_EOL;
75        }
76    }
77}
78
79// 関数を実行
80uploadFileExample();

curl_file_create関数は、PHPのcURL機能を使ってファイルをアップロードする際に、アップロード対象のファイル情報をまとめたCURLFileオブジェクトを生成するために使用します。これにより、安全なファイルアップロード処理を実現できます。

関数の第一引数$filenameには、アップロードしたいファイルのローカルパスを文字列で指定します。第二引数$mime_typeには、'text/plain'のようなファイルのMIMEタイプを、第三引数$posted_filenameには、サーバー側で認識させたいファイル名を指定します。後ろ2つの引数は省略可能です。

このサンプルコードでは、まずテスト用のテキストファイルを一時的に作成します。次にcurl_file_createを使い、そのファイルのパス、MIMEタイプ、サーバー側でのファイル名を指定してCURLFileオブジェクトを生成しています。このオブジェクトを、他の送信データ（ユーザー名など）と一緒に配列に格納し、curl_setopt関数のCURLOPT_POSTFIELDSオプションに設定することで、ファイルを含むPOSTリクエストを送信します。リクエスト実行後は、サーバーからの応答を表示し、最後に作成した一時ファイルを削除して処理を終えます。