[PHP 4, PHP 5, PHP 7, PHP 8]
file — Reads entire file into an array
Description
file[string $filename, int $flags = 0, ?resource $context = null]:
array|false
Note:
You can use file_get_contents[] to return the contents of a file as a string.
Parameters
filenamePath 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 contextA 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_LINESis 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.
Errors/Exceptions
Emits an E_WARNING level error if the file does not exist.
Examples
Example #1 file[] example