PHP マニュアル: ファイルポインタから行を取得し、CSVフィールドを処理する

説明

arrayfalse fgetcsv(
    resource $stream,
    intnull $length = null,
    string $separator = ",",
    string $enclosure = "\"",
    string $escape = "\\"
)

fgets に動作は似ていますが、 fgetcsv は行を CSV フォーマットのフィールドとして読込み処理を行い、読み込んだフィールドを含む配列を返すという違いがあります。

注意: この関数はロケール設定を考慮します。例えば、LC_CTYPE が en_US.UTF-8 の場合、 1 バイトエンコーディングでエンコードされたデータが間違って処理されるかもしれません。

パラメータ

stream

ファイルポインタは有効なものでなければならず、また fopen, popen, もしくは fsockopen で正常にオープンされたファイルを指している必要があります。

length

(行末文字を考慮して) CSV ファイルにある最も長い行よりも大きい必要があります。そうでない場合は、ひとつの行が length 文字ずつのチャンクに分割されてしまいます。ただし、フィールド囲いこみ文字の内部では、この分割は発生しません。

このパラメータを省略 (もしくは 0 を設定、 PHP 8.0.0 以降では null を設定) すると、最大行長は制限されません。この場合、若干動作が遅くなります。

separator

separator パラメータで、フィールドのデリミタを設定します。シングルバイト文字 1 文字のみでなければなりません。

enclosure

オプションの enclosure パラメータで、フィールド囲いこみ文字を設定します。シングルバイト文字 1 文字のみでなければなりません。

escape

オプションの escape パラメータで、エスケープ文字を設定します。シングルバイト文字 1 文字のみ、または空文字列でなければなりません。空文字列("") を指定すると、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。

注意: enclosure の文字は、フィールド内で2回出力されることでエスケープされます。しかし、 escape 文字はその代替として使えます。デフォルトのパラメータの値 "" と \" は同じ意味を持ちます。 enclosure の文字を escape 文字でエスケープすることには、特別な意味はありません。それ自身をエスケープする意味ですらありません。

警告

PHP 8.4.0 以降では、escape のデフォルト値に依存することは非推奨となりました。位置指定の引数か、名前付き引数を使用して明示的に指定する必要があります。

警告

escape が空の文字列("")以外に設定されているとき、 » RFC 4180 に準拠しない CSV が生成されたり、PHP の CSV 関数を介してラウンドトリップ(往復変換)でデータが壊れる可能性があります。 escapeのデフォルト値は"\\" なので、明示的に空の文字列を指定することを推奨します。デフォルト値は、PHP 9.0 以降の将来のバージョンで変更予定です。

戻り値

読み込んだフィールドの内容を含む数値添字配列を返します。失敗した場合に false を返します

注意:
CSV ファイルの空行は null フィールドを一つだけ含む配列として返され、エラーにはなりません。

注意: マッキントッシュコンピュータ上で作成されたファイルを読み込む際に、 PHP が行末を認識できないという問題が発生した場合、実行時の設定オプションauto_detect_line_endings を有効にする必要が生じるかもしれません。

エラー / 例外

separator または enclosure が 1 バイト長ではない場合、ValueError をスローします。

escape が 1 バイト長、または空文字列ではない場合、 ValueError をスローします。

変更履歴

バージョン	説明
8.4.0	`escape` のデフォルト値に依存することは、非推奨になりました。
8.3.0	最後のフィールドが、閉じられていないフィールド囲いこみ文字だけの場合、 null バイト 1 つの文字列ではなく、空文字列を返すようになりました。
8.0.0	`length` は、nullable になりました。
7.4.0	`escape` パラメータが空文字列を受け入れるようになりました。この場合、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。

警告

escape が空の文字列("")以外に設定されているとき、 » RFC 4180 に準拠しない CSV が生成されたり、PHP の CSV 関数を介してラウンドトリップ(往復変換)でデータが壊れる可能性があります。 escapeのデフォルト値は"\\" なので、明示的に空の文字列を指定することを推奨します。デフォルト値は、PHP 9.0 以降の将来のバージョンで変更予定です。

例

例1 CSV ファイルの全てのコンテンツを読み込み、表示する

<?php
$row = 1;
if (($handle = fopen("test.csv", "r")) !== FALSE) {
    while (($data = fgetcsv($handle, 1000, ",")) !== FALSE) {
        $num = count($data);
        echo "<p> $num fields in line $row: <br /></p>\n";
        $row++;
        for ($c=0; $c < $num; $c++) {
            echo $data[$c] . "<br />\n";
        }
    }
    fclose($handle);
}
?>

参考

fputcsv
str_getcsv
SplFileObject::fgetcsv
SplFileObject::fputcsv
SplFileObject::setCsvControl
SplFileObject::getCsvControl
explode
file
pack