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

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer