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

Usage

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

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

Arguments

NameType(s)Description
filenamestring

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

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #384
    In the 384th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new module called Session Allow, and highlight a new site of the week. Read on!
    Weekly.pw / 18 September 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK