On this page
WP_Filesystem_ftpsockets::delete( string $file, bool $recursive = false, string|false $type = false ): bool
Deletes a file or directory.
Parameters
$filestring Required-
Path to the file or directory.
$recursivebool Optional-
If set to true, deletes files and folders recursively.
Default:
false $typestring|false Optional-
Type of resource.
'f'for file,'d'for directory.
Default:
false
Return
bool True on success, false on failure.
Source
File: wp-admin/includes/class-wp-filesystem-ftpsockets.php. View all references
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 );
}
Related
Uses
| Uses | Description |
|---|---|
| WP_Filesystem_ftpsockets::is_file() wp-admin/includes/class-wp-filesystem-ftpsockets.php | Checks if resource is a file. |
Used By
| Used By | Description |
|---|---|
| WP_Filesystem_ftpsockets::rmdir() wp-admin/includes/class-wp-filesystem-ftpsockets.php | Deletes a directory. |
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_filesystem_ftpsockets/delete