PHP is developed and maintained by a global community of contributors.
The PHP Foundation helps fund this work. If PHP is part of your business or projects, consider sponsoring the Foundation.
(PHP 4, PHP 5, PHP 7, PHP 8)
fgets — Gets line from file pointer
Gets a line from file pointer.
streamThe file pointer must be valid, and must point to a file successfully opened by fopen() or fsockopen() (and not yet closed by fclose()).
length
Reading ends when length - 1 bytes have been
read, or a newline (which is included in the return value), or an EOF
(whichever comes first). If no length is specified, it will keep
reading from the stream until it reaches the end of the line.
Returns a string of up to length - 1 bytes read from
the file pointed to by stream. If there is no more data
to read in the file pointer, then false is returned.
If an error occurs, false is returned.
Example #1 Reading a file line by line
<?php
$fp = @fopen("/tmp/inputfile.txt", "r");
if ($fp) {
while (($buffer = fgets($fp, 4096)) !== false) {
echo $buffer, PHP_EOL;
}
if (!feof($fp)) {
echo "Error: unexpected fgets() fail\n";
}
fclose($fp);
}
?>Note:
Prior to PHP 8.1.0, the auto_detect_line_endings run-time configuration option could be enabled to help PHP properly recognize line endings when reading files created on Macintosh systems. This option has been deprecated as of PHP 8.1.0. If necessary, handle
"\r"line breaks manually instead.
Note:
People used to the 'C' semantics of fgets() should note the difference in how
EOFis returned.
