wireChmod() function

Change the mode of a file or directory (optionally recursive)

If no $chmod mode argument is specified the $config->chmodFile or $config->chmodDir` settings will be used.

This is procedural version of the $files->chmod() method.

Usage

// basic usage
$bool = wireChmod(string $path);

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

Arguments

NameType(s)Description
pathstring

May be a directory or a filename

recursive (optional)bool

If set to true, all files and directories in $path will be recursively set as well.

chmod (optional)string

If you want to set the mode to something other than PW'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

See Also


Functions methods and properties

API reference based on ProcessWire core version 3.0.125

Twitter updates

  • New post: This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new Page if() method— More
    15 February 2019
  • New post: ProcessWire 3.0.125 has several useful new Sanitizer methods & options, plus new ways to access them directly from the Input API variable. This makes handling user input even easier than before. Plus updates to our i18n functions & API docs— More
    25 January 2019
  • New post: In this week’s post, we’ll take a look a look at the new website and focus on some parts of it and how they were built. Then we’ll dive into the latest version of ProcessWire on the dev branch, version 3.0.124— More
    11 January 2019

Latest news

  • ProcessWire Weekly #249
    In the 249th issue of ProcessWire Weekly we're going to walk you through the latest core updates (ProcessWire 3.0.126), introduce a new third party module called Page Access Releasetime, and pick a new site of the week. Read on!
    Weekly.pw / 16 February 2019
  • ProcessWire 3.0.126 core updates
    This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new $page->if() method. 
    Blog / 15 February 2019
  • 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