WordPress at Your Fingertips
function is not described

WP_Filesystem_SSH2::delete() public WP 2.7.0

Deletes a file or 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->delete( $file, $recursive, $type );
$file(string) (required)
Path to the file or directory.
$recursive(true|false)
If set to true, deletes files and folders recursively.
Default: false
$type(string|false)
Type of resource. 'f' for file, 'd' for directory.
Default: false

Changelog

Since 2.7.0 Introduced.

Code of WP_Filesystem_SSH2::delete() WP 5.8.2

public function delete( $file, $recursive = false, $type = false ) {
	if ( 'f' === $type || $this->is_file( $file ) ) {
		return ssh2_sftp_unlink( $this->sftp_link, $file );
	}

	if ( ! $recursive ) {
		return ssh2_sftp_rmdir( $this->sftp_link, $file );
	}

	$filelist = $this->dirlist( $file );

	if ( is_array( $filelist ) ) {
		foreach ( $filelist as $filename => $fileinfo ) {
			$this->delete( $file . '/' . $filename, $recursive, $fileinfo['type'] );
		}
	}

	return ssh2_sftp_rmdir( $this->sftp_link, $file );
}