wp_ajax_update_plugin()

Compatibility

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

Performance profile

How much work a call to wp_ajax_update_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

Expensive

Reaches an outbound HTTP request via wp_remote_post().

Scaling

Constant

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

Instructions

102–172

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

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

• hookthird-party callbacksdo_action()one call below wp_ajax_update_plugin()
• optionoption read or writeget_option()one call below wp_ajax_update_plugin()
• transienttransientget_site_transient()one call below wp_ajax_update_plugin()
• httpoutbound HTTP requestwp_remote_post()one call below wp_ajax_update_plugin()
• cacheobject cachewp_cache_get()one call below wp_ajax_update_plugin()

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

What one call costs · 264 distinct outcomes

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

Uses · 17

• check_ajax_referer()Verifies the Ajax request to prevent processing requests external of the blog.
• wp_send_json_error()Sends a JSON response back to an Ajax request, indicating failure.
• __()Retrieves the translation of $text.
• plugin_basename()Gets the basename of a plugin.
• sanitize_text_field()Sanitizes a string from user input or from the database.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• sanitize_key()Sanitizes a string key.
• current_user_can()Returns whether the current user has the specified capability.
• validate_file()Validates a file name and path against an allowed set of rules.
• get_plugin_data()Parses the plugin contents to retrieve plugin's metadata.
• wp_update_plugins()Checks for available updates to plugins based on the latest versions hosted on WordPress.org.
• is_wp_error()Checks whether the given variable is a WordPress Error.

Source code

View on Trac ↗View on GitHub ↗

4645function wp_ajax_update_plugin() {4646	check_ajax_referer( 'updates' );4647 4648	if ( empty( $_POST['plugin'] ) || empty( $_POST['slug'] ) ) {4649		wp_send_json_error(4650			array(4651				'slug'         => '',4652				'errorCode'    => 'no_plugin_specified',4653				'errorMessage' => __( 'No plugin specified.' ),4654			)4655		);4656	}4657 4658	$plugin = plugin_basename( sanitize_text_field( wp_unslash( $_POST['plugin'] ) ) );4659 4660	$status = array(4661		'update'     => 'plugin',4662		'slug'       => sanitize_key( wp_unslash( $_POST['slug'] ) ),4663		'oldVersion' => '',4664		'newVersion' => '',4665	);4666 4667	if ( ! current_user_can( 'update_plugins' ) || 0 !== validate_file( $plugin ) ) {4668		$status['errorMessage'] = __( 'Sorry, you are not allowed to update plugins for this site.' );4669		wp_send_json_error( $status );4670	}4671 4672	$plugin_data          = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin );4673	$status['plugin']     = $plugin;4674	$status['pluginName'] = $plugin_data['Name'];4675 4676	if ( $plugin_data['Version'] ) {4677		/* translators: %s: Plugin version. */4678		$status['oldVersion'] = sprintf( __( 'Version %s' ), $plugin_data['Version'] );4679	}4680 4681	require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';4682 4683	wp_update_plugins();4684 4685	$skin     = new WP_Ajax_Upgrader_Skin();4686	$upgrader = new Plugin_Upgrader( $skin );4687	$result   = $upgrader->bulk_upgrade( array( $plugin ) );4688 4689	if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {4690		$status['debug'] = $skin->get_upgrade_messages();4691	}4692 4693	if ( is_wp_error( $skin->result ) ) {4694		$status['errorCode']    = $skin->result->get_error_code();4695		$status['errorMessage'] = $skin->result->get_error_message();4696		wp_send_json_error( $status );4697	} elseif ( $skin->get_errors()->has_errors() ) {4698		$status['errorMessage'] = $skin->get_error_messages();4699		wp_send_json_error( $status );4700	} elseif ( is_array( $result ) && ! empty( $result[ $plugin ] ) ) {4701 4702		/*4703		 * Plugin is already at the latest version.4704		 *4705		 * This may also be the return value if the `update_plugins` site transient is empty,4706		 * e.g. when you update two plugins in quick succession before the transient repopulates.4707		 *4708		 * Preferably something can be done to ensure `update_plugins` isn't empty.4709		 * For now, surface some sort of error here.4710		 */4711		if ( true === $result[ $plugin ] ) {4712			$status['errorMessage'] = $upgrader->strings['up_to_date'];4713			wp_send_json_error( $status );4714		}4715 4716		$plugin_data = get_plugins( '/' . $result[ $plugin ]['destination_name'] );4717		$plugin_data = reset( $plugin_data );4718 4719		if ( $plugin_data['Version'] ) {4720			/* translators: %s: Plugin version. */4721			$status['newVersion'] = sprintf( __( 'Version %s' ), $plugin_data['Version'] );4722		}4723 4724		wp_send_json_success( $status );

Changelog

Introduced in 4.2.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 7.1.0 tag, from src/wp-admin/includes/ajax-actions.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.