WP_Filesystem_SSH2::delete( string $file, bool $recursive = false, string|false $type = false ): bool

Deletes a file or directory.


Parameters

$file string Required
Path to the file or directory.
$recursive bool Optional
If set to true, deletes files and folders recursively.

Default: false

$type string|false Optional
Type of resource. 'f' for file, 'd' for directory.

Default: false


Top ↑

Return

bool True on success, false on failure.


Top ↑

Source

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

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 );
}


Top ↑

Changelog

Changelog
Version Description
2.7.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.