WP_Filesystem_SSH2::chmod( string $file, int|false $mode = false, bool $recursive = false )

Changes filesystem permissions.


Description Description


Parameters Parameters

$file

(string) (Required) Path to the file.

$mode

(int|false) (Optional) The permissions as octal number, usually 0644 for files, 0755 for directories.

Default value: false

$recursive

(bool) (Optional) If set to true, changes file group recursively.

Default value: false


Top ↑

Return Return

(bool) True on success, false on failure.


Top ↑

Source Source

File: wp-admin/includes/class-wp-filesystem-ssh2.php

	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 );
	}

Top ↑

Changelog Changelog

Changelog
Version Description
2.7.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.