WordPress at Your Fingertips
function is not described

Plugin_Upgrader::upgrade() public WP 2.8.0

Upgrade a plugin.

{} It's a method of the class: Plugin_Upgrader{}

No Hooks.

Return

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

Usage

$Plugin_Upgrader = new Plugin_Upgrader();
$Plugin_Upgrader->upgrade( $plugin, $args );
$plugin(string) (required)
Path to the plugin file relative to the plugins directory.
$args(array)

Other arguments for upgrading a plugin package.

Default: empty array

  • clear_update_cache(true|false)
    Whether to clear the plugin updates cache if successful.
    Default: true

Changelog

Since 2.8.0 Introduced.
Since 3.7.0 The $args parameter was added, making clearing the plugin update cache optional.

Code of Plugin_Upgrader::upgrade() WP 5.8.2

public function upgrade( $plugin, $args = array() ) {
	$defaults    = array(
		'clear_update_cache' => true,
	);
	$parsed_args = wp_parse_args( $args, $defaults );

	$this->init();
	$this->upgrade_strings();

	$current = get_site_transient( 'update_plugins' );
	if ( ! isset( $current->response[ $plugin ] ) ) {
		$this->skin->before();
		$this->skin->set_result( false );
		$this->skin->error( 'up_to_date' );
		$this->skin->after();
		return false;
	}

	// Get the URL to the zip file.
	$r = $current->response[ $plugin ];

	add_filter( 'upgrader_pre_install', array( $this, 'deactivate_plugin_before_upgrade' ), 10, 2 );
	add_filter( 'upgrader_pre_install', array( $this, 'active_before' ), 10, 2 );
	add_filter( 'upgrader_clear_destination', array( $this, 'delete_old_plugin' ), 10, 4 );
	add_filter( 'upgrader_post_install', array( $this, 'active_after' ), 10, 2 );
	// There's a Trac ticket to move up the directory for zips which are made a bit differently, useful for non-.org plugins.
	// 'source_selection' => array( $this, 'source_selection' ),
	if ( $parsed_args['clear_update_cache'] ) {
		// Clear cache so wp_update_plugins() knows about the new plugin.
		add_action( 'upgrader_process_complete', 'wp_clean_plugins_cache', 9, 0 );
	}

	$this->run(
		array(
			'package'           => $r->package,
			'destination'       => WP_PLUGIN_DIR,
			'clear_destination' => true,
			'clear_working'     => true,
			'hook_extra'        => array(
				'plugin' => $plugin,
				'type'   => 'plugin',
				'action' => 'update',
			),
		)
	);

	// Cleanup our hooks, in case something else does a upgrade on this connection.
	remove_action( 'upgrader_process_complete', 'wp_clean_plugins_cache', 9 );
	remove_filter( 'upgrader_pre_install', array( $this, 'deactivate_plugin_before_upgrade' ) );
	remove_filter( 'upgrader_pre_install', array( $this, 'active_before' ) );
	remove_filter( 'upgrader_clear_destination', array( $this, 'delete_old_plugin' ) );
	remove_filter( 'upgrader_post_install', array( $this, 'active_after' ) );

	if ( ! $this->result || is_wp_error( $this->result ) ) {
		return $this->result;
	}

	// Force refresh of plugin update information.
	wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );

	// Ensure any future auto-update failures trigger a failure email by removing
	// the last failure notification from the list when plugins update successfully.
	$past_failure_emails = get_option( 'auto_plugin_theme_update_emails', array() );

	if ( isset( $past_failure_emails[ $plugin ] ) ) {
		unset( $past_failure_emails[ $plugin ] );
		update_option( 'auto_plugin_theme_update_emails', $past_failure_emails );
	}

	return true;
}