WP_Filesystem_ftpsockets::chmod() WordPress Method

The chmod() method is part of the WP_Filesystem_ftpsockets class, which is used to connect to a FTP server and perform various operations on files and folders. This particular method is used to change the permissions on a file or folder. The first parameter is the path to the file or folder, and the second parameter is the octal value for the new permissions.

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

Changes filesystem permissions.


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 permissions recursively.

Default value: false


Top ↑

Return

(bool) True on success, false on failure.


Top ↑

Source

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

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

		// chmod any sub-objects if recursive.
		if ( $recursive && $this->is_dir( $file ) ) {
			$filelist = $this->dirlist( $file );

			foreach ( (array) $filelist as $filename => $filemeta ) {
				$this->chmod( $file . '/' . $filename, $mode, $recursive );
			}
		}

		// chmod the file or directory.
		return $this->ftp->chmod( $file, $mode );
	}


Top ↑

Changelog

Changelog
VersionDescription
2.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.