WP_Plugin_Dependencies::get_dependency_api_data(): array|null

Compatibility

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

Return value

array|null

An array of dependency API data, or null on early exit.

Performance profile

How much work a call to WP_Plugin_Dependencies::get_dependency_api_data() 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_get().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

5–56

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

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
• hookthird-party callbacksapply_filters()one call below WP_Plugin_Dependencies::get_dependency_api_data()
• cacheobject cachewp_cache_get()one call below WP_Plugin_Dependencies::get_dependency_api_data()
• optionnetwork optionget_site_option()one call below WP_Plugin_Dependencies::get_dependency_api_data()
• httpoutbound HTTP requestwp_remote_get()one call below WP_Plugin_Dependencies::get_dependency_api_data()

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

What one call costs · 2 distinct outcomes

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

Uses · 7

• is_admin()Determines whether the current request is for an administrative interface page.
• get_site_transient()Retrieves the value of a site transient.
• set_site_transient()Sets/updates the value of a site transient.
• plugins_api()Retrieves plugin installer pages from the WordPress.org Plugins API.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• WP_Plugin_Dependencies::get_plugins()Gets data for installed plugins.
• WP_Plugin_Dependencies::get_dependency_filepath()Gets the filepath for a dependency, relative to the plugin's directory.

Used by · 3

• WP_Plugin_Dependencies::get_dependency_data()Returns API data for the dependency.
• WP_Plugin_Dependencies::get_dependency_names()Gets the names of plugins required by the plugin.
• WP_Plugin_Dependencies::initialize()Initializes by fetching plugin header and plugin API data.

Source code

View on Trac ↗View on GitHub ↗

650	protected static function get_dependency_api_data() {651		global $pagenow;652 653		if ( ! is_admin() || ( 'plugins.php' !== $pagenow && 'plugin-install.php' !== $pagenow ) ) {654			return null;655		}656 657		if ( is_array( self::$dependency_api_data ) ) {658			return self::$dependency_api_data;659		}660 661		$plugins                   = self::get_plugins();662		self::$dependency_api_data = (array) get_site_transient( 'wp_plugin_dependencies_plugin_data' );663		foreach ( self::$dependency_slugs as $slug ) {664			// Set transient for individual data, remove from self::$dependency_api_data if transient expired.665			if ( ! get_site_transient( "wp_plugin_dependencies_plugin_timeout_{$slug}" ) ) {666				unset( self::$dependency_api_data[ $slug ] );667				set_site_transient( "wp_plugin_dependencies_plugin_timeout_{$slug}", true, 12 * HOUR_IN_SECONDS );668			}669 670			if ( isset( self::$dependency_api_data[ $slug ] ) ) {671				if ( false === self::$dependency_api_data[ $slug ] ) {672					$dependency_file = self::get_dependency_filepath( $slug );673 674					if ( false === $dependency_file ) {675						self::$dependency_api_data[ $slug ] = array( 'Name' => $slug );676					} else {677						self::$dependency_api_data[ $slug ] = array( 'Name' => $plugins[ $dependency_file ]['Name'] );678					}679					continue;680				}681 682				// Don't hit the Plugin API if data exists.683				if ( ! empty( self::$dependency_api_data[ $slug ]['last_updated'] ) ) {684					continue;685				}686			}687 688			if ( ! function_exists( 'plugins_api' ) ) {689				require_once ABSPATH . 'wp-admin/includes/plugin-install.php';690			}691 692			$information = plugins_api(693				'plugin_information',694				array(695					'slug'   => $slug,696					'fields' => array(697						'short_description' => true,698						'icons'             => true,699					),700				)701			);702 703			if ( is_wp_error( $information ) ) {704				continue;705			}706 707			self::$dependency_api_data[ $slug ] = (array) $information;708			// plugins_api() returns 'name' not 'Name'.709			self::$dependency_api_data[ $slug ]['Name'] = self::$dependency_api_data[ $slug ]['name'];710			set_site_transient( 'wp_plugin_dependencies_plugin_data', self::$dependency_api_data, 0 );711		}712 713		// Remove from self::$dependency_api_data if slug no longer a dependency.714		$differences = array_diff( array_keys( self::$dependency_api_data ), self::$dependency_slugs );715		foreach ( $differences as $difference ) {716			unset( self::$dependency_api_data[ $difference ] );717		}718 719		ksort( self::$dependency_api_data );720		// Remove empty elements.721		self::$dependency_api_data = array_filter( self::$dependency_api_data );722		set_site_transient( 'wp_plugin_dependencies_plugin_data', self::$dependency_api_data, 0 );723 724		return self::$dependency_api_data;725	}

Changelog

Introduced in 6.5.0. One change between 6.7.7 and 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-includes/class-wp-plugin-dependencies.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.