WordPress at Your Fingertips
function is not described

WP_Filesystem_SSH2::chmod() public WP 2.7.0

Changes filesystem permissions.

{} It's a method of the class: WP_Filesystem_SSH2{}

No Hooks.

Return

true|false. True on success, false on failure.

Usage

$WP_Filesystem_SSH2 = new WP_Filesystem_SSH2();
$WP_Filesystem_SSH2->chmod( $file, $mode, $recursive );
$file(string) (required)
Path to the file.
$mode(int|false)
The permissions as octal number, usually 0644 for files,
0755 for directories.
Default: false
$recursive(true|false)
If set to true, changes file permissions recursively.
Default: false

Changelog

Since 2.7.0 Introduced.

Code of WP_Filesystem_SSH2::chmod() WP 5.8.2

public function chmod( $file, $mode = false, $recursive = false ) {
	if ( ! $this->exists( $file ) ) {
		return false;
	}

	if ( ! $mode ) {
		if ( $this->is_file( $file ) ) {
			$mode = FS_CHMOD_FILE;
		} elseif ( $this->is_dir( $file ) ) {
			$mode = FS_CHMOD_DIR;
		} else {
			return false;
		}
	}

	if ( ! $recursive || ! $this->is_dir( $file ) ) {
		return $this->run_command( sprintf( 'chmod %o %s', $mode, escapeshellarg( $file ) ), true );
	}

	return $this->run_command( sprintf( 'chmod -R %o %s', $mode, escapeshellarg( $file ) ), true );
}