WP_Filesystem_FTPext::delete( string $file, bool $recursive = false, string|false $type = false ): bool
- Since
- 2.5.0
- Source
wp-admin/includes/class-wp-filesystem-ftpext.php:394
Compatibility
- WordPress
- since 2.5.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$filestring- Path to the file or directory.
$recursivebooloptional- If set to true, deletes files and folders recursively.
Default false.Default:false $typestring|falseoptional- Type of resource. 'f' for file, 'd' for directory.
Default false.Default:false
Return value
bool- True on success, false on failure.
Performance profile
How much work a call to WP_Filesystem_FTPext::delete() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Scales with input
- Instructions
- 6–31
- Plugin surface
- None
- Called by
- 2
Reaches the database via WP_Filesystem_FTPext::delete().
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 58.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- sqldatabase query
WP_Filesystem_FTPext::delete()this function does it
What one call costs · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Filesystem_FTPext::delete() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($file) | 6 | none |
!empty($file) && $type === "f" | 14 | ftp_delete() |
!empty($file) && $type !== "f" && ->is_file() | 18 | ->is_file(), ftp_delete() |
!empty($file) && $type !== "f" && !->is_file() | 19 | ->is_file(), ftp_rmdir() |
!empty($file) && $type !== "f" && !->is_file() | 28–31 | ->is_file(), trailingslashit(), ->dirlist(), ftp_rmdir() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 58 | 6–31 | 7 | |
| 8.5 | 58 | 6–31 | 7 | |
| 8.4 | 58 | 6–31 | 7 | |
| 8.3 | 58 | 6–31 | 7 | |
| 8.2 | 58 | 6–31 | 7 | 3 more instructions than PHP 8.1 |
| 8.1 | 55 | 6–30 | 7 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 56 | 6–30 | 7 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 4
- trailingslashit()Appends a trailing slash.
- WP_Filesystem_FTPext::is_file()Checks if resource is a file.
- WP_Filesystem_FTPext::dirlist()Gets details for files in a directory or a specific file.
- WP_Filesystem_FTPext::delete()Deletes a file or directory.
Used by · 2
- WP_Filesystem_FTPext::delete()Deletes a file or directory.
- WP_Filesystem_FTPext::rmdir()Deletes a directory.
Source code
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 ); }Changelog
Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-admin/includes/class-wp-filesystem-ftpext.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.