WP_Filesystem_SSH2::rmdir() WordPress Method

The WP_Filesystem_SSH2::rmdir() function deletes a directory on a SSH server.

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


Top ↑

Return

(bool) True on success, false on failure.


Top ↑

Source

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

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


Top ↑

Changelog

Changelog
VersionDescription
2.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.