Php/docs/function.fputcsv
fputcsv
(PHP 5 >= 5.1.0, PHP 7)
fputcsv — Format line as CSV and write to file pointer
Description
fputcsv
( resource $handle
, array $fields
[, string $delimiter
= ","
[, string $enclosure
= '"'
[, string $escape_char
= "\\"
]]] ) : int|false
fputcsv() formats a line (passed as a
fields
array) as CSV and writes it (terminated by a
newline) to the specified file handle
.
Parameters
handle
- The file pointer must be valid, and must point to a file successfully opened by fopen() or fsockopen() (and not yet closed by fclose()).
fields
- An array of strings.
delimiter
- The optional
delimiter
parameter sets the field delimiter (one character only). enclosure
- The optional
enclosure
parameter sets the field enclosure (one character only). escape_char
- The optional
escape_char
parameter sets the escape character (at most one character). An empty string (""
) disables the proprietary escape mechanism.
Note:
If an
enclosure
character is contained in a field, it will be escaped by doubling it, unless it is immediately preceded by anescape_char
.
Return Values
Returns the length of the written string or FALSE
on failure.
Changelog
Version | Description |
---|---|
7.4.0 | The escape_char parameter now also accepts an empty
string to disable the proprietary escape mechanism. |
5.5.4 | The escape_char parameter was added
|
Examples
Example #1 fputcsv() example
<?php$list = array ( array('aaa', 'bbb', 'ccc', 'dddd'), array('123', '456', '789'), array('"aaa"', '"bbb"'));$fp = fopen('file.csv', 'w');foreach ($list as $fields) { fputcsv($fp, $fields);}fclose($fp);?>
The above example will write the following to file.csv
:
aaa,bbb,ccc,dddd 123,456,789 """aaa""","""bbb"""
Notes
Note:
If PHP is not properly recognizingthe line endings when reading files either on or created by a Macintosh computer, enabling the auto_detect_line_endings run-time configuration option may help resolve the problem.