$files->filePutContents() method

Create (overwrite or append) a file, put the $contents in it, and adjust permissions

This is the same as PHP’s file_put_contents() except that it’s preferable to use this in ProcessWire because it adjusts the file permissions configured with $config->chmodFile.

Usage

// basic usage
$int = $files->filePutContents(string $filename, $contents);

// usage with all arguments
$int = $files->filePutContents(string $filename, $contents, int $flags = 0);

Arguments

NameType(s)Description
filenamestring

Filename to write to

contentsstring, mixed

Contents to write to file

flags (optional)int

Flags to modify behavior:

  • FILE_APPEND (constant): Append to file if it already exists.
  • LOCK_EX (constant): Acquire exclusive lock to file while writing.

Return value

int bool

Number of bytes written or boolean false on fail

Exceptions

Method can throw exceptions on error:

  • WireException - if given invalid $filename (since 3.0.118)

See Also


$files methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #560
    In the 560th issue of ProcessWire Weekly we'll check out the latest core updates, cover newly released ProcessWire modules, and more. Read on!
    Weekly.pw / 1 February 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • 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