WordPress at Your Fingertips
function is not described

WP_Filesystem_SSH2::rmdir() public WP 2.7.0

Deletes a directory.

{} It's a method of the class: WP_Filesystem_SSH2{}

No Hooks.

Return

true|false. True on success, false on failure.

Usage

$WP_Filesystem_SSH2 = new WP_Filesystem_SSH2();
$WP_Filesystem_SSH2->rmdir( $path, $recursive );
$path(string) (required)
Path to directory.
$recursive(true|false)
Whether to recursively remove files/directories.
Default: false

Changelog

Since 2.7.0 Introduced.

Code of WP_Filesystem_SSH2::rmdir() WP 5.8.2

public function rmdir( $path, $recursive = false ) {
	return $this->delete( $path, $recursive );
}