$files->chmod() method

Change the read/write mode of a file or directory, consistent with ProcessWire's configuration settings

Unless a specific mode is provided via the $chmod argument, this method uses the $config->chmodDir and $config->chmodFile settings in /site/config.php.

This method also provides the option of going recursive, adjusting the read/write mode for an entire file/directory tree at once.

The $recursive or $chmod arguments may be optionally swapped in order (since 3.0.34).

Example

// Update the mode of /site/assets/cache/foo-bar/ recursively
$files->chmod($config->paths->cache . 'foo-bar/', true); 

Usage

// basic usage
$bool = $files->chmod(string $path);

// usage with all arguments
$bool = $files->chmod(string $path, $recursive = false, $chmod = null);

Arguments

NameType(s)Description
pathstring

Path or file that you want to adjust mode for (may be a path/directory or a filename).

recursive (optional)bool, string

If set to true, all files and directories in $path will be recursively set as well (default=false).

chmod (optional)string, null, bool

If you want to set the mode to something other than ProcessWire's chmodFile/chmodDir settings, you may override it by specifying it here. Ignored otherwise. Format should be a string, like "0755".

Return value

bool

Returns true if all changes were successful, or false if at least one chmod failed.

Exceptions

Method can throw exceptions on error:

  • WireException - when it receives incorrect chmod format


$files methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • Introduction to an invoice application profile being built in ProcessWire: More
    30 September 2022
  • Stumbling upon a really nice ProcessWire-powered website, plus core updates including API improvements for ProcessWire forms— More
    9 September 2022
  • Useful new dot-and-bracket syntax options added for page.get() method— More
    2 September 2022

Latest news

  • ProcessWire Weekly #438
    In the 348th issue of ProcessWire Weekly we're going to cover the latest weekly update from Ryan, take a closer look at a couple of new third party modules, and more. Read on!
    Weekly.pw / 1 October 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 2022
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.