Plugin_Upgrader::bulk_upgrade( string[] $plugins, array $args = array() ): array|false

In this article

Upgrades several plugins at once.

Parameters

$pluginsstring[]required
Array of paths to plugin files relative to the plugins directory.
$argsarrayoptional
Other arguments for upgrading several plugins at once.
  • clear_update_cache bool
    Whether to clear the plugin updates cache if successful. Default true.

Default:array()

Return

array|false An array of results indexed by plugin file, or false if unable to connect to the filesystem.

Source

public function bulk_upgrade( $plugins, $args = array() ) {
	global $wp_version;

	$defaults    = array(
		'clear_update_cache' => true,
	);
	$parsed_args = wp_parse_args( $args, $defaults );

	$this->init();
	$this->bulk = true;
	$this->upgrade_strings();

	$current = get_site_transient( 'update_plugins' );

	add_filter( 'upgrader_clear_destination', array( $this, 'delete_old_plugin' ), 10, 4 );

	$this->skin->header();

	// Connect to the filesystem first.
	$res = $this->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
	if ( ! $res ) {
		$this->skin->footer();
		return false;
	}

	$this->skin->bulk_header();

	/*
	 * Only start maintenance mode if:
	 * - running Multisite and there are one or more plugins specified, OR
	 * - a plugin with an update available is currently active.
	 * @todo For multisite, maintenance mode should only kick in for individual sites if at all possible.
	 */
	$maintenance = ( is_multisite() && ! empty( $plugins ) );
	foreach ( $plugins as $plugin ) {
		$maintenance = $maintenance || ( is_plugin_active( $plugin ) && isset( $current->response[ $plugin ] ) );
	}
	if ( $maintenance ) {
		$this->maintenance_mode( true );
	}

	$results = array();

	$this->update_count   = count( $plugins );
	$this->update_current = 0;
	foreach ( $plugins as $plugin ) {
		++$this->update_current;
		$this->skin->plugin_info = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin, false, true );

		if ( ! isset( $current->response[ $plugin ] ) ) {
			$this->skin->set_result( 'up_to_date' );
			$this->skin->before();
			$this->skin->feedback( 'up_to_date' );
			$this->skin->after();
			$results[ $plugin ] = true;
			continue;
		}

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

		$this->skin->plugin_active = is_plugin_active( $plugin );

		if ( isset( $r->requires ) && ! is_wp_version_compatible( $r->requires ) ) {
			$result = new WP_Error(
				'incompatible_wp_required_version',
				sprintf(
					/* translators: 1: Current WordPress version, 2: WordPress version required by the new plugin version. */
					__( 'Your WordPress version is %1$s, however the new plugin version requires %2$s.' ),
					$wp_version,
					$r->requires
				)
			);

			$this->skin->before( $result );
			$this->skin->error( $result );
			$this->skin->after();
		} elseif ( isset( $r->requires_php ) && ! is_php_version_compatible( $r->requires_php ) ) {
			$result = new WP_Error(
				'incompatible_php_required_version',
				sprintf(
					/* translators: 1: Current PHP version, 2: PHP version required by the new plugin version. */
					__( 'The PHP version on your server is %1$s, however the new plugin version requires %2$s.' ),
					PHP_VERSION,
					$r->requires_php
				)
			);

			$this->skin->before( $result );
			$this->skin->error( $result );
			$this->skin->after();
		} else {
			add_filter( 'upgrader_source_selection', array( $this, 'check_package' ) );
			$result = $this->run(
				array(
					'package'           => $r->package,
					'destination'       => WP_PLUGIN_DIR,
					'clear_destination' => true,
					'clear_working'     => true,
					'is_multi'          => true,
					'hook_extra'        => array(
						'plugin'      => $plugin,
						'temp_backup' => array(
							'slug' => dirname( $plugin ),
							'src'  => WP_PLUGIN_DIR,
							'dir'  => 'plugins',
						),
					),
				)
			);
			remove_filter( 'upgrader_source_selection', array( $this, 'check_package' ) );
		}

		$results[ $plugin ] = $result;

		// Prevent credentials auth screen from displaying multiple times.
		if ( false === $result ) {
			break;
		}
	} // End foreach $plugins.

	$this->maintenance_mode( false );

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

	/** This action is documented in wp-admin/includes/class-wp-upgrader.php */
	do_action(
		'upgrader_process_complete',
		$this,
		array(
			'action'  => 'update',
			'type'    => 'plugin',
			'bulk'    => true,
			'plugins' => $plugins,
		)
	);

	$this->skin->bulk_footer();

	$this->skin->footer();

	// Cleanup our hooks, in case something else does an upgrade on this connection.
	remove_filter( 'upgrader_clear_destination', array( $this, 'delete_old_plugin' ) );

	/*
	 * 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() );

	foreach ( $results as $plugin => $result ) {
		// Maintain last failure notification when plugins failed to update manually.
		if ( ! $result || is_wp_error( $result ) || ! isset( $past_failure_emails[ $plugin ] ) ) {
			continue;
		}

		unset( $past_failure_emails[ $plugin ] );
	}

	update_option( 'auto_plugin_theme_update_emails', $past_failure_emails );

	return $results;
}

Hooks

do_action( ‘upgrader_process_complete’, WP_Upgrader $upgrader, array $hook_extra )

Fires when the upgrader process is complete.

Changelog

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

User Contributed Notes

You must log in before being able to contribute a note or feedback.