W3cubDocs

/WordPress

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

Changes the file group.

Parameters

$filestringrequired
Path to the file.
$groupstring|intrequired
A group name or number.
$recursivebooloptional
If set to true, changes file group recursively.

Default:false

Return

bool True on success, false on failure.

Source

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

Changelog

Version Description
2.7.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/chgrp