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

Parameters

$pluginsstring[]

Array of paths to plugin files relative to the plugins directory.

$argsarrayoptional

Other arguments for upgrading several plugins at once.Default: array()

• $clear_update_cachebooldefault: true

  Whether to clear the plugin updates cache if successful.

Return

array|false

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

Hooks fired · 1

One hook fires while Plugin_Upgrader::bulk_upgrade() runs, in this order:

1. 1
   do_action( upgrader_process_complete )actionline 412 (+127 into the body)

   Fires when the upgrader process is complete.

Uses · 22

• wp_get_wp_version()Returns the current WordPress version.
• 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.
• is_multisite()Determines whether Multisite is enabled.
• is_plugin_active()Determines whether a plugin is active.
• get_plugin_data()Parses the plugin contents to retrieve plugin's metadata.
• is_wp_version_compatible()Checks compatibility with the current WordPress version.
• __()Retrieves the translation of $text.
• is_php_version_compatible()Checks compatibility with the current PHP version.
• remove_filter()Removes a callback function from a filter hook.
• wp_clean_plugins_cache()Clears the plugins cache used by get_plugins() and by default, the plugin updates cache.

Source

View on Trac ↗View on GitHub ↗

285	public function bulk_upgrade( $plugins, $args = array() ) {286		$wp_version = wp_get_wp_version();287 288		$defaults    = array(289			'clear_update_cache' => true,290		);291		$parsed_args = wp_parse_args( $args, $defaults );292 293		$this->init();294		$this->bulk = true;295		$this->upgrade_strings();296 297		$current = get_site_transient( 'update_plugins' );298 299		add_filter( 'upgrader_clear_destination', array( $this, 'delete_old_plugin' ), 10, 4 );300 301		$this->skin->header();302 303		// Connect to the filesystem first.304		$res = $this->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );305		if ( ! $res ) {306			$this->skin->footer();307			return false;308		}309 310		$this->skin->bulk_header();311 312		/*313		 * Only start maintenance mode if:314		 * - running Multisite and there are one or more plugins specified, OR315		 * - a plugin with an update available is currently active.316		 * @todo For multisite, maintenance mode should only kick in for individual sites if at all possible.317		 */318		$maintenance = ( is_multisite() && ! empty( $plugins ) );319		foreach ( $plugins as $plugin ) {320			$maintenance = $maintenance || ( is_plugin_active( $plugin ) && isset( $current->response[ $plugin ] ) );321		}322		if ( $maintenance ) {323			$this->maintenance_mode( true );324		}325 326		$results = array();327 328		$this->update_count   = count( $plugins );329		$this->update_current = 0;330		foreach ( $plugins as $plugin ) {331			++$this->update_current;332			$this->skin->plugin_info = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin, false, true );333 334			if ( ! isset( $current->response[ $plugin ] ) ) {335				$this->skin->set_result( 'up_to_date' );336				$this->skin->before();337				$this->skin->feedback( 'up_to_date' );338				$this->skin->after();339				$results[ $plugin ] = true;340				continue;341			}342 343			// Get the URL to the zip file.344			$r = $current->response[ $plugin ];345 346			$this->skin->plugin_active = is_plugin_active( $plugin );347 348			if ( isset( $r->requires ) && ! is_wp_version_compatible( $r->requires ) ) {349				$result = new WP_Error(350					'incompatible_wp_required_version',351					sprintf(352						/* translators: 1: Current WordPress version, 2: WordPress version required by the new plugin version. */353						__( 'Your WordPress version is %1$s, however the new plugin version requires %2$s.' ),354						$wp_version,355						$r->requires356					)357				);358 359				$this->skin->before( $result );360				$this->skin->error( $result );361				$this->skin->after();362			} elseif ( isset( $r->requires_php ) && ! is_php_version_compatible( $r->requires_php ) ) {363				$result = new WP_Error(364					'incompatible_php_required_version',

History

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.8.8 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.