fgetcsv
(PHP 4, PHP 5, PHP 7, PHP 8)
fgetcsv — Gets line from file pointer and parse for CSV fields
Description
resource
$stream,?int
$length = null,string
$separator = ",",string
$enclosure = "\"",string
$escape = "\\"): array|false
Similar to fgets() except that fgetcsv() parses the line it reads for fields in CSV format and returns an array containing the fields read.
Note:
The locale settings are taken into account by this function. If
LC_CTYPEis e.g.en_US.UTF-8, files in one-byte encodings may be read wrongly by this function.
Parameters
-
stream -
A valid file pointer to a file successfully opened by fopen(), popen(), or fsockopen().
-
length -
Must be greater than the longest line (in characters) to be found in the CSV file (allowing for trailing line-end characters). Otherwise the line is split in chunks of
lengthcharacters, unless the split would occur inside an enclosure.Omitting this parameter (or setting it to 0, or
nullin PHP 8.0.0 or later) the maximum line length is not limited, which is slightly slower. -
separator -
The optional
separatorparameter sets the field separator (one single-byte character only). -
enclosure -
The optional
enclosureparameter sets the field enclosure character (one single-byte character only). -
escape -
The optional
escapeparameter sets the escape character (at most one single-byte character). An empty string ("") disables the proprietary escape mechanism.Note: Usually an
enclosurecharacter is escaped inside a field by doubling it; however, theescapecharacter can be used as an alternative. So for the default parameter values""and\"have the same meaning. Other than allowing to escape theenclosurecharacter theescapecharacter has no special meaning; it isn't even meant to escape itself.
Return Values
Returns an indexed array containing the fields read on success, or false on failure.
Note:
A blank line in a CSV file will be returned as an array comprising a single null field, and will not be treated as an error.
Note: If PHP is not properly recognizing the 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.
Changelog
| Version | Description |
|---|---|
| 8.0.0 |
length is now nullable.
|
| 7.4.0 |
The escape parameter now also accepts an empty
string to disable the proprietary escape mechanism.
|
Examples
Example #1 Read and print the entire contents of a CSV file
<?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);
}
?>
See Also
- str_getcsv() - Parse a CSV string into an array
- explode() - Split a string by a string
- file() - Reads entire file into an array
- pack() - Pack data into binary string
- fputcsv() - Format line as CSV and write to file pointer
