Plugin_Upgrader::upgrade( string $plugin, array $args = array() ): bool|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$pluginstring

Path to the plugin file relative to the plugins directory.

$argsarrayoptional

Other arguments for upgrading a plugin package. Default empty array.Default: array()

• $clear_update_cachebooldefault: true

  Whether to clear the plugin updates cache if successful.

Return value

bool|WP_Error

True if the upgrade was successful, false or a WP_Error object otherwise.

Performance profile

How much work a call to Plugin_Upgrader::upgrade() 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

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

34–143

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 160.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• transienttransientget_site_transient()called directly
• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()one call below Plugin_Upgrader::upgrade()
• cacheobject cachewp_cache_get()one call below Plugin_Upgrader::upgrade()
• serializeserialisationmaybe_unserialize()one call below Plugin_Upgrader::upgrade()

Further down the call graph this can also reach query. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 9 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost Plugin_Upgrader::upgrade() can have, taken from its control-flow graph on PHP 8.5.

Uses · 13

• wp_parse_args()Merges user defined arguments into defaults array.
• get_site_transient()Retrieves the value of a site transient.
• add_filter()Adds a callback function to a filter hook.
• add_action()Adds a callback function to an action hook.
• remove_action()Removes a callback function from an action hook.
• remove_filter()Removes a callback function from a filter hook.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_clean_plugins_cache()Clears the plugins cache used by get_plugins() and by default, the plugin updates cache.
• get_option()Retrieves an option value based on an option name.
• update_option()Updates the value of an option that was already added.
• Plugin_Upgrader::init()
• Plugin_Upgrader::upgrade_strings()Initializes the upgrade strings.

Source code

View on Trac ↗View on GitHub ↗

190	public function upgrade( $plugin, $args = array() ) {191		$defaults    = array(192			'clear_update_cache' => true,193		);194		$parsed_args = wp_parse_args( $args, $defaults );195 196		$this->init();197		$this->upgrade_strings();198 199		$current = get_site_transient( 'update_plugins' );200		if ( ! isset( $current->response[ $plugin ] ) ) {201			$this->skin->before();202			$this->skin->set_result( false );203			$this->skin->error( 'up_to_date' );204			$this->skin->after();205			return false;206		}207 208		// Get the URL to the zip file.209		$r = $current->response[ $plugin ];210 211		add_filter( 'upgrader_pre_install', array( $this, 'deactivate_plugin_before_upgrade' ), 10, 2 );212		add_filter( 'upgrader_pre_install', array( $this, 'active_before' ), 10, 2 );213		add_filter( 'upgrader_clear_destination', array( $this, 'delete_old_plugin' ), 10, 4 );214		add_filter( 'upgrader_post_install', array( $this, 'active_after' ), 10, 2 );215		/*216		 * There's a Trac ticket to move up the directory for zips which are made a bit differently, useful for non-.org plugins.217		 * 'source_selection' => array( $this, 'source_selection' ),218		 */219		if ( $parsed_args['clear_update_cache'] ) {220			// Clear cache so wp_update_plugins() knows about the new plugin.221			add_action( 'upgrader_process_complete', 'wp_clean_plugins_cache', 9, 0 );222		}223 224		$this->run(225			array(226				'package'           => $r->package,227				'destination'       => WP_PLUGIN_DIR,228				'clear_destination' => true,229				'clear_working'     => true,230				'hook_extra'        => array(231					'plugin'      => $plugin,232					'type'        => 'plugin',233					'action'      => 'update',234					'temp_backup' => array(235						'slug' => dirname( $plugin ),236						'src'  => WP_PLUGIN_DIR,237						'dir'  => 'plugins',238					),239				),240			)241		);242 243		// Cleanup our hooks, in case something else does an upgrade on this connection.244		remove_action( 'upgrader_process_complete', 'wp_clean_plugins_cache', 9 );245		remove_filter( 'upgrader_pre_install', array( $this, 'deactivate_plugin_before_upgrade' ) );246		remove_filter( 'upgrader_pre_install', array( $this, 'active_before' ) );247		remove_filter( 'upgrader_clear_destination', array( $this, 'delete_old_plugin' ) );248		remove_filter( 'upgrader_post_install', array( $this, 'active_after' ) );249 250		if ( ! $this->result || is_wp_error( $this->result ) ) {251			return $this->result;252		}253 254		// Force refresh of plugin update information.255		wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );256 257		/*258		 * Ensure any future auto-update failures trigger a failure email by removing259		 * the last failure notification from the list when plugins update successfully.260		 */261		$past_failure_emails = get_option( 'auto_plugin_theme_update_emails', array() );262 263		if ( isset( $past_failure_emails[ $plugin ] ) ) {264			unset( $past_failure_emails[ $plugin ] );265			update_option( 'auto_plugin_theme_update_emails', $past_failure_emails );266		}267 268		return true;269	}

Changelog

Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 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.