WP_Filesystem_SSH2::chown() WordPress Method

The WP_Filesystem_SSH2::chown() method is used to change the owner of a file or directory on the server. This is useful if you need to change the ownership of a file or directory for security reasons.

WP_Filesystem_SSH2::chown( string $file, string|int $owner, bool $recursive = false ) #

Changes the owner of a file or directory.


Parameters

$file

(string)(Required)Path to the file or directory.

$owner

(string|int)(Required)A user name or number.

$recursive

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

Default value: false


Top ↑

Return

(bool) True on success, false on failure.


Top ↑

Source

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

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

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

		return $this->run_command( sprintf( 'chown -R %s %s', escapeshellarg( $owner ), escapeshellarg( $file ) ), true );
	}


Top ↑

Changelog

Changelog
VersionDescription
2.7.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.