Title: WP_Filesystem_SSH2::chgrp
Published: April 25, 2014
Last modified: August 20, 2026

---

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

## In this article

 * [Parameters](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/chgrp/?output_format=md#parameters)
 * [Return](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/chgrp/?output_format=md#return)
 * [Source](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/chgrp/?output_format=md#source)
 * [Related](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/chgrp/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/chgrp/?output_format=md#changelog)

[ Back to top](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/chgrp/?output_format=md#wp--skip-link--target)

Changes the file group.

## 󠀁[Parameters](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/chgrp/?output_format=md#parameters)󠁿

 `$file`stringrequired

Path to the file.

`$group`string|intrequired

A group name or number.

`$recursive`booloptional

If set to true, changes file group recursively.

Default:`false`

## 󠀁[Return](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/chgrp/?output_format=md#return)󠁿

 bool True on success, false on failure.

## 󠀁[Source](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/chgrp/?output_format=md#source)󠁿

    ```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( (string) $group ), escapeshellarg( $file ) ), true );
    	}

    	return $this->run_command( sprintf( 'chgrp -R %s %s', escapeshellarg( (string) $group ), escapeshellarg( $file ) ), true );
    }
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-admin/includes/class-wp-filesystem-ssh2.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/7.1/src/wp-admin/includes/class-wp-filesystem-ssh2.php#L391)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/7.1/src/wp-admin/includes/class-wp-filesystem-ssh2.php#L391-L401)

## 󠀁[Related](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/chgrp/?output_format=md#related)󠁿

| Uses | Description | 
| [WP_Filesystem_SSH2::exists()](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/exists/)`wp-admin/includes/class-wp-filesystem-ssh2.php` |

Checks if a file or directory exists.

  | 
| [WP_Filesystem_SSH2::is_dir()](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/is_dir/)`wp-admin/includes/class-wp-filesystem-ssh2.php` |

Checks if resource is a directory.

  | 
| [WP_Filesystem_SSH2::run_command()](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/run_command/)`wp-admin/includes/class-wp-filesystem-ssh2.php` |  |

| Used by | Description | 
| [WP_Filesystem_SSH2::mkdir()](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/mkdir/)`wp-admin/includes/class-wp-filesystem-ssh2.php` |

Creates a directory.

  |

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/chgrp/?output_format=md#changelog)󠁿

| Version | Description | 
| [2.7.0](https://developer.wordpress.org/reference/since/2.7.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_filesystem_ssh2%2Fchgrp%2F)
before being able to contribute a note or feedback.