file

PHP 4, PHP 5, PHP 7, PHP 8
file - Reads entire file into an array
Manual
Code Examples

file( string$filename, [int$flags = 0], [resource|null$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.

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 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

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:

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.

Exceptions and Errors

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

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.

Related Functions

Example of file

Show all examples for file

PHP Version:


Function file:

Filesystem Functions

Most used PHP functions