$files->fileGetContents() method

Get contents of file

This is the same as PHP’s file_get_contents() except that the arguments are simpler and it may be preferable to use this in ProcessWire for future cases where the file system may be abstracted from the installation.

Available since version 3.0.167.


// basic usage
$bool = $files->fileGetContents(string $filename);

// usage with all arguments
$bool = $files->fileGetContents(string $filename, int $offset = 0, int $maxlen = 0);



Full path and filename to read

offset (optional)int

The offset where the reading starts on the original stream. Negative offsets count from the end of the stream.

maxlen (optional)int

Maximum length of data read. The default is to read until end of file is reached.

Return value

bool string

Returns the read data (string) or boolean false on failure.

See Also

$files methods and properties

API reference based on ProcessWire core version 3.0.228

Latest news

  • ProcessWire Weekly #498
    The 498th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 November 2023
  • Using date range fields in ProcessWire
    This week we'll take a detailed look at the newest addition to the ProFields set of modules: the Date Range Fieldtype and Inputfield.
    Blog / 24 November 2023
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH