array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ja', ), 'this' => array ( 0 => 'function.fputcsv.php', 1 => 'fputcsv', 2 => '行を CSV 形式にフォーマットし、ファイルポインタに書き込む', ), 'up' => array ( 0 => 'ref.filesystem.php', 1 => 'ファイルシステム 関数', ), 'prev' => array ( 0 => 'function.fpassthru.php', 1 => 'fpassthru', ), 'next' => array ( 0 => 'function.fputs.php', 1 => 'fputs', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ja', 'path' => 'reference/filesystem/functions/fputcsv.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

fputcsv

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

fputcsv — 行を CSV 形式にフォーマットし、ファイルポインタに書き込む

説明

fputcsv(
    resource $stream,
    array $fields,
    string $separator = ",",
    string $enclosure = "\"",
    string $escape = "\\",
    string $eol = "\n"
): int|false

fputcsv() は、行（fields 配列として渡されたもの）を CSV としてフォーマットし、それを、 指定した stream に書き込みます (いちばん最後に eol を追加します)。

パラメータ

stream

ファイルポインタは、有効なファイルポインタである必要があり、 fopen() または fsockopen() で正常にオープンされた （そしてまだ fclose() でクローズされていない） ファイルを指している必要があります。

fields

文字列の配列。

separator

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

enclosure

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

escape

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

警告

入力ストリームにおいて、enclosure 文字は クォートされた文字列の中で2回連続させることで常にエスケープでき、 パース結果では単一の enclosure 文字になります。 escape 文字の動作は異なります: 入力中に escape と enclosure 文字の並びが出現した場合、 パース結果には両方の文字がそのまま残ります。 よって、デフォルトのパラメータの場合、 "a""b","c\"d" のような CSV の行は それぞれ a"b と c\"d にパースされます。

警告

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

eol

eol は、 カスタムの行末シーケンスを設定するオプションの引数です。

警告

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

注意:

enclosure がフィールド内に含まれる場合は、同じ文字を二度続けることでエスケープします。 ただし、その直前に escape がある場合は別です。

戻り値

書き込んだ文字列の長さを返します。失敗した場合に false を返します。

エラー / 例外

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

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

変更履歴

バージョン 説明
8.4.0 escape のデフォルト値に依存することは、 非推奨になりました。
8.1.0 オプションの引数 eol が追加されました。
7.4.0 escape パラメータが、 (RFC 4180 に準拠していない) 独自仕様のエスケープ機構を無効にするため、 空文字列を受け入れるようになりました。

例

例1 fputcsv() の例

<?php

$list = [
['aaa', 'bbb', 'ccc', 'dddd'],
['123', '456', '789'],
['"aaa"', '"bbb"']
];

$fp = fopen('file.csv', 'w');

foreach ($list as $fields) {
fputcsv($fp, $fields, ',', '"', '');
}

fclose($fp);
?>

上の例が書き出す file.csv の内容は、このようになります。

aaa,bbb,ccc,dddd
123,456,789
"""aaa""","""bbb"""

参考