fgets()
fgets() — Gets line from file pointer.
Built-in function of PHP 8.5. The manual lists it as available in PHP 4, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.
Signature
fgets(resource $stream, ?int $length = null): string|false
Parameters
| Parameter | Type | What it takes |
|---|---|---|
| $stream | resource | The file pointer must be valid, and must point to a file successfully opened by fopen() or fsockopen() (and not yet closed by fclose()). |
| $length | ?int | 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. |
Return value
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
A runnable snippet:
$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); }
See also
fread(), fgetc(), stream_get_line(), fopen(), popen(), fsockopen(), stream_set_timeout()
All PHP 8.5 built-in functions
Reference card built from the PHP manual page fgets() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.