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

Twitter updates

  • ProcessWire 3.0.190 has 15 commits relative to 3.0.189 and contains a mixture of issue resolutions and feature additions. We’ll review these below, in addition to updates for the PageAutosave and ProFields Table modules— More
    3 December 2021
  • Great video by @jlahijani that demonstrates his ProcessWire page builder using ProFields Repeater Matrix, the new Page Autosave + Live Preview module and Uikit 3— youtube.com/watch?v=Rb5kiU…
    13 November 2021
  • More development on page automatic save this week, plus the addition of live preview— More
    12 November 2021

Latest news

  • ProcessWire Weekly #395
    In the 395th issue of ProcessWire Weekly we'll cover the latest core updates, check out the MJLM to HTML module, and more. Read on!
    Weekly.pw / 4 December 2021
  • ProcessWire 3.0.190 core updates
    ProcessWire 3.0.190 has 15 commits relative to 3.0.189 and contains a mixture of issue resolutions and feature additions. This post covers them all, in addition to updates for the PageAutosave and ProFields Table modules.
    Blog / 3 December 2021
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull