WP_Filesystem_ftpsockets::delete() WordPress Method
The WP_Filesystem_ftpsockets::delete() function is used to delete a file or directory from an FTP server. This function takes two parameters: the path to the file or directory to be deleted, and the recursive flag. If the recursive flag is set to true, the function will delete all files and directories in the specified path.
WP_Filesystem_ftpsockets::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-ftpsockets.php
public function delete( $file, $recursive = false, $type = false ) { if ( empty( $file ) ) { return false; } if ( 'f' === $type || $this->is_file( $file ) ) { return $this->ftp->delete( $file ); } if ( ! $recursive ) { return $this->ftp->rmdir( $file ); } return $this->ftp->mdel( $file ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.5.0 | Introduced. |