On this page
WP_Filesystem_SSH2::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-ssh2.php. View all references
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 );
}
Related
Uses
| Uses | Description |
|---|---|
| WP_Filesystem_SSH2::is_file() wp-admin/includes/class-wp-filesystem-ssh2.php | Checks if resource is a file. |
| WP_Filesystem_SSH2::dirlist() wp-admin/includes/class-wp-filesystem-ssh2.php | Gets details for files in a directory or a specific file. |
| WP_Filesystem_SSH2::delete() wp-admin/includes/class-wp-filesystem-ssh2.php | Deletes a file or directory. |
Used By
| Used By | Description |
|---|---|
| WP_Filesystem_SSH2::rmdir() wp-admin/includes/class-wp-filesystem-ssh2.php | Deletes a directory. |
| WP_Filesystem_SSH2::move() wp-admin/includes/class-wp-filesystem-ssh2.php | Moves a file. |
| WP_Filesystem_SSH2::delete() wp-admin/includes/class-wp-filesystem-ssh2.php | Deletes a file or directory. |
Changelog
| Version | Description |
|---|---|
| 2.7.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/delete