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

Deletes a file or directory.


Parameters Parameters

$file

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

$recursive

(bool) (Optional) If set to true, deletes files and folders 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-ftpext.php

	public function delete( $file, $recursive = false, $type = false ) {
		if ( empty( $file ) ) {
			return false;
		}
		if ( 'f' == $type || $this->is_file( $file ) ) {
			return ftp_delete( $this->link, $file );
		}
		if ( ! $recursive ) {
			return ftp_rmdir( $this->link, $file );
		}

		$filelist = $this->dirlist( trailingslashit( $file ) );
		if ( ! empty( $filelist ) ) {
			foreach ( $filelist as $delete_file ) {
				$this->delete( trailingslashit( $file ) . $delete_file['name'], $recursive, $delete_file['type'] );
			}
		}
		return ftp_rmdir( $this->link, $file );
	}


Top ↑

Changelog Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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