W3cubDocs

/WordPress

WP_Filesystem_SSH2::rmdir( string $path, bool $recursive = false )

Deletes a directory.

Parameters

$path

(string) (Required) Path to directory.

$recursive

(bool) (Optional) Whether to recursively remove files/directories.

Default value: false

Return

(bool) True on success, false on failure.

Source

File: wp-admin/includes/class-wp-filesystem-ssh2.php

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

Changelog

Version Description
2.7.0 Introduced.

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