WP_Filesystem_FTPext::delete() WordPress Method
The WP_Filesystem_FTPext::delete() method deletes a file or directory from the server. This is a destructive operation and cannot be undone. Use with caution.
WP_Filesystem_FTPext::delete( string $file, bool $recursive = false, string|false $type = false ) #
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 value: false
- $type
(string|false)(Optional)Type of resource. 'f' for file, 'd' for directory.
Default value: false
Return
(bool) True on success, false on failure.
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 ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.5.0 | Introduced. |