Plugin_Upgrader::delete_old_plugin( bool|WP_Error $removed, string $local_destination, string $remote_destination, array $plugin ): bool|WP_Error
- Since
- 2.8.0
- Source
wp-admin/includes/class-plugin-upgrader.php:675
Description
Hooked to the 'upgrader_clear_destination' filter by Plugin_Upgrader::upgrade() and Plugin_Upgrader::bulk_upgrade().
Compatibility
- WordPress
- since 2.8.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
$removedbool|WP_Error- Whether the destination was cleared.
True on success, WP_Error on failure. $local_destinationstring- The local package destination.
$remote_destinationstring- The remote package destination.
$pluginarray- Extra arguments passed to hooked filters.
Return value
bool|WP_Error
Performance profile
How much work a call to Plugin_Upgrader::delete_old_plugin() 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
- Constant
- Instructions
- 10–47
- Plugin surface
- None
- Called by
- 0
Reaches the database via ->delete().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 63.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- sqldatabase query
->delete()called directly - hookthird-party callbacks
do_action()one call below Plugin_Upgrader::delete_old_plugin()
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost Plugin_Upgrader::delete_old_plugin() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 10–23 | is_wp_error() |
!is_wp_error() && !empty($plugin) && !->exists() | 28–29 | is_wp_error(), ->wp_plugins_dir(), trailingslashit(), ->exists() |
!is_wp_error() && !empty($plugin) && ->exists() | 36–47 | is_wp_error(), ->wp_plugins_dir(), trailingslashit(), ->exists(), ->delete() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 63 | 10–47 | 7 | |
| 8.5 | 63 | 10–47 | 7 | |
| 8.4 | 63 | 10–47 | 7 | 5 fewer instructions than PHP 8.3 |
| 8.3 | 68 | 10–52 | 7 | |
| 8.2 | 68 | 10–52 | 7 | |
| 8.1 | 68 | 10–52 | 7 | |
| 7.4 | 68 | 10–52 | 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 · 3
- is_wp_error()Checks whether the given variable is a WordPress Error.
- trailingslashit()Appends a trailing slash.
- WP_Error::__construct()Initializes the error.
Source code
public function delete_old_plugin( $removed, $local_destination, $remote_destination, $plugin ) { global $wp_filesystem; if ( is_wp_error( $removed ) ) { return $removed; // Pass errors through. } $plugin = $plugin['plugin'] ?? ''; if ( empty( $plugin ) ) { return new WP_Error( 'bad_request', $this->strings['bad_request'] ); } $plugins_dir = $wp_filesystem->wp_plugins_dir(); $this_plugin_dir = trailingslashit( dirname( $plugins_dir . $plugin ) ); if ( ! $wp_filesystem->exists( $this_plugin_dir ) ) { // If it's already vanished. return $removed; } /* * If plugin is in its own directory, recursively delete the directory. * Base check on if plugin includes directory separator AND that it's not the root plugin folder. */ if ( strpos( $plugin, '/' ) && $this_plugin_dir !== $plugins_dir ) { $deleted = $wp_filesystem->delete( $this_plugin_dir, true ); } else { $deleted = $wp_filesystem->delete( $plugins_dir . $plugin ); } if ( ! $deleted ) { return new WP_Error( 'remove_old_failed', $this->strings['remove_old_failed'] ); } return true; }Changelog
Introduced in 2.8.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.1.0 tag, from
src/wp-admin/includes/class-plugin-upgrader.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.