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

Deletes a file or directory.


Description Description


Parameters Parameters

$file

(string) (Required) Path to the file or directory.

$recursive

(bool) (Optional) If set to true, changes file group recursively.

Default value: false

$type

(string|false) (Optional) Type of resource. 'f' for file, 'd' for directory.

Default value: false


Top ↑

Return Return

(bool) True on success, false on failure.


Top ↑

Source Source

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

	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

Changelog
Version Description
2.7.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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