install_plugin_install_status( array|object $api, bool $loop = false ): array

Compatibility

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

Parameters

$apiarray|object

Data about the plugin retrieved from the API.

$loopbooloptional

Disable further loops. Default false.Default: false

Return value

array

Plugin installation status data.

• $statusstring

  Status of a plugin. Could be one of 'install', 'update_available', 'latest_installed' or 'newer_installed'.

• $urlstring

  Plugin installation URL.

• $versionstring

  The most recent version of the plugin.

• $filestring

  Plugin filename relative to the plugins directory.

Performance profile

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

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

27–119

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• transienttransientget_site_transient()called directly
• filesystemfilesystem accessis_dir()called directly
• hookthird-party callbacksapply_filters()one call below install_plugin_install_status()
• cacheobject cachewp_cache_get()one call below install_plugin_install_status()
• optionnetwork optionget_site_option()one call below install_plugin_install_status()
• httpoutbound HTTP requestwp_remote_post()one call below install_plugin_install_status()

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 · 45 distinct outcomes

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

Uses · 9

• get_site_transient()Retrieves the value of a site transient.
• current_user_can()Returns whether the current user has the specified capability.
• wp_nonce_url()Retrieves URL with nonce added to URL query.
• self_admin_url()Retrieves the URL to the admin area for either the current site or the network depending on context.
• get_plugins()Checks the plugins directory and retrieve all plugin files with plugin data.
• delete_site_transient()Deletes a site transient.
• wp_update_plugins()Checks for available updates to plugins based on the latest versions hosted on WordPress.org.
• install_plugin_install_status()Determines the status we can perform on a plugin.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.

Used by · 3

• install_plugin_install_status()Determines the status we can perform on a plugin.
• wp_ajax_install_plugin()Handles installing a plugin via AJAX.
• wp_get_plugin_action_button()Gets the markup for the plugin install action button.

Source code

View on Trac ↗View on GitHub ↗

440function install_plugin_install_status( $api, $loop = false ) {441	// This function is called recursively, $loop prevents further loops.442	if ( is_array( $api ) ) {443		$api = (object) $api;444	}445 446	// Default to a "new" plugin.447	$status      = 'install';448	$url         = false;449	$update_file = false;450	$version     = '';451 452	/*453	 * Check to see if this plugin is known to be installed,454	 * and has an update awaiting it.455	 */456	$update_plugins = get_site_transient( 'update_plugins' );457	if ( isset( $update_plugins->response ) ) {458		foreach ( (array) $update_plugins->response as $file => $plugin ) {459			if ( $plugin->slug === $api->slug ) {460				$status      = 'update_available';461				$update_file = $file;462				$version     = $plugin->new_version;463				if ( current_user_can( 'update_plugins' ) ) {464					$url = wp_nonce_url( self_admin_url( 'update.php?action=upgrade-plugin&plugin=' . $update_file ), 'upgrade-plugin_' . $update_file );465				}466				break;467			}468		}469	}470 471	if ( 'install' === $status ) {472		if ( is_dir( WP_PLUGIN_DIR . '/' . $api->slug ) ) {473			$installed_plugin = get_plugins( '/' . $api->slug );474			if ( empty( $installed_plugin ) ) {475				if ( current_user_can( 'install_plugins' ) ) {476					$url = wp_nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $api->slug ), 'install-plugin_' . $api->slug );477				}478			} else {479				$key = array_keys( $installed_plugin );480				/*481				 * Use the first plugin regardless of the name.482				 * Could have issues for multiple plugins in one directory if they share different version numbers.483				 */484				$key = reset( $key );485 486				$update_file = $api->slug . '/' . $key;487				if ( version_compare( $api->version, $installed_plugin[ $key ]['Version'], '=' ) ) {488					$status = 'latest_installed';489				} elseif ( version_compare( $api->version, $installed_plugin[ $key ]['Version'], '<' ) ) {490					$status  = 'newer_installed';491					$version = $installed_plugin[ $key ]['Version'];492				} else {493					// If the above update check failed, then that probably means that the update checker has out-of-date information, force a refresh.494					if ( ! $loop ) {495						delete_site_transient( 'update_plugins' );496						wp_update_plugins();497						return install_plugin_install_status( $api, true );498					}499				}500			}501		} else {502			// "install" & no directory with that slug.503			if ( current_user_can( 'install_plugins' ) ) {504				$url = wp_nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $api->slug ), 'install-plugin_' . $api->slug );505			}506		}507	}508	if ( isset( $_GET['from'] ) ) {509		$url .= '&amp;from=' . urlencode( wp_unslash( $_GET['from'] ) );510	}511 512	$file = $update_file;513	return compact( 'status', 'url', 'version', 'file' );514}

Changelog

Introduced in 3.0.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/plugin-install.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.