WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Filesystem_SSH2::chgrp()

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

In this article

Back to top

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

View all references View on Trac View on GitHub

UsesDescription
WP_Filesystem_SSH2::exists()wp-admin/includes/class-wp-filesystem-ssh2.php

Checks if a file or directory exists.

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 byDescription
WP_Filesystem_SSH2::mkdir()wp-admin/includes/class-wp-filesystem-ssh2.php

Creates a directory.

Changelog

VersionDescription
2.7.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.