On this page
WP_Filesystem_SSH2::chmod( string $file, int|false $mode = false, bool $recursive = false ): bool
Changes filesystem permissions.
Parameters
$filestring Required-
Path to the file.
$modeint|false Optional-
The permissions as octal number, usually 0644 for files, 0755 for directories.
Default:
false $recursivebool Optional-
If set to true, changes file permissions recursively.
Default:
false
Return
bool True on success, false on failure.
Source
File: wp-admin/includes/class-wp-filesystem-ssh2.php. View all references
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 );
}
Related
Uses
| Uses | Description |
|---|---|
| WP_Filesystem_SSH2::exists() wp-admin/includes/class-wp-filesystem-ssh2.php | Checks if a file or directory exists. |
| WP_Filesystem_SSH2::is_file() wp-admin/includes/class-wp-filesystem-ssh2.php | Checks if resource is a file. |
| WP_Filesystem_SSH2::is_dir() wp-admin/includes/class-wp-filesystem-ssh2.php | Checks if resource is a directory. |
| WP_Filesystem_SSH2::run_command() wp-admin/includes/class-wp-filesystem-ssh2.php |
Used By
| Used By | Description |
|---|---|
| WP_Filesystem_SSH2::put_contents() wp-admin/includes/class-wp-filesystem-ssh2.php | Writes a string to a file. |
Changelog
| Version | Description |
|---|---|
| 2.7.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/chmod