Description

function file(string $filename, int $flags = 0, ?resource $context = null): array|false

Reads an entire file into an array.

Note:
You can use file_get_contents() to return the contents of a file as a string.

Parameters

filename

Path to the file.

Tip

A URL can be used as a filename with this function if the fopen wrappers have been enabled. See fopen() for more details on how to specify the filename. See the Supported Protocols and Wrappers for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide.

flags

The optional parameter flags can be one, or more, of the following constants:

FILE_USE_INCLUDE_PATH: Search for the file in the include_path.
FILE_IGNORE_NEW_LINES: Omit newline at the end of each array element.
FILE_SKIP_EMPTY_LINES: Skip empty lines.
FILE_NO_DEFAULT_CONTEXT: Don't use the default context.

context

A context stream resource.

Return Values

Returns the file in an array. Each element of the array corresponds to a line in the file, with the newline still attached. Upon failure, file() returns false.

Note:
Each line in the resulting array will include the line ending, unless FILE_IGNORE_NEW_LINES is used.

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.

Errors/Exceptions

As of PHP 8.3.0, throws a ValueError if flags includes any invalid values, such as FILE_APPEND.

Emits an E_WARNING level error if the file does not exist.

Changelog

Version	Description
8.3.0	ValueError is thrown for any invalid values of `flags`.

Examples

Example #1 file() example

<?php
// Get a file into an array.  In this example we'll go through HTTP to get
// the HTML source of a URL.
$lines = file('http://www.example.com/');

// Loop through our array, show HTML source as HTML source; and line numbers too.
foreach ($lines as $line_num => $line) {
    echo "Line #<b>{$line_num}</b> : " . htmlspecialchars($line) . "<br />\n";
}

// Using the optional flags parameter
$trimmed = file('somefile.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
?>

Notes

Warning

When using SSL, Microsoft IIS will violate the protocol by closing the connection without sending a close_notify indicator. PHP will report this as "SSL: Fatal Protocol Error" when you reach the end of the data. To work around this, the value of error_reporting should be lowered to a level that does not include warnings. PHP can detect buggy IIS server software when you open the stream using the https:// wrapper and will suppress the warning. When using fsockopen() to create an ssl:// socket, the developer is responsible for detecting and suppressing this warning.