WP_Filesystem_SSH2::chgrp() WordPress Method

The WP_Filesystem_SSH2::chgrp() Wordpress method is used to change the group ownership of a given file to a specified group. This method does not support changing the group ownership of directories.

WP_Filesystem_SSH2::chgrp( string $file, string|int $group, bool $recursive = false ) #

Changes the file group.


Parameters

$file

(string)(Required)Path to the file.

$group

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

$recursive

(bool)(Optional) If set to true, changes file group 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 chgrp( $file, $group, $recursive = false ) {
		if ( ! $this->exists( $file ) ) {
			return false;
		}

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

		return $this->run_command( sprintf( 'chgrp -R %s %s', escapeshellarg( $group ), 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.