WP_REST_Plugins_Controller::create_item( WP_REST_Request $request ): WP_REST_Response|WP_Error

Compatibility

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

Parameters

$requestWP_REST_Request

Full details about the request.

Return value

WP_REST_Response|WP_Error

Response object on success, or WP_Error object on failure.

Performance profile

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

Constant

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

Instructions

6

Executed per call on PHP 8.5. The body compiles to 245.

Plugin surface

1 hook

Third-party callbacks on 'plugins_update_check_locales' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• httpoutbound HTTP requestwp_remote_get()one call below WP_REST_Plugins_Controller::create_item()

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

What one call costs · 1 distinct outcome

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

Hooks and filters fired · 1

One hook fires while WP_REST_Plugins_Controller::create_item() runs, in this order:

1. 1
   apply_filters( plugins_update_check_locales )filterline 381 (+108 into the body)

   Filters the locales requested for plugin translations.

Uses · 16

• is_wp_error()Checks whether the given variable is a WordPress Error.
• plugins_api()Retrieves plugin installer pages from the WordPress.org Plugins API.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• __()Retrieves the translation of $text.
• get_available_languages()Gets all available languages based on the presence of *.mo and *.l10n.php files in a given directory.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_plugin_data()Parses the plugin contents to retrieve plugin's metadata.
• rest_url()Retrieves the URL to a REST endpoint.
• WP_REST_Plugins_Controller::is_filesystem_available()Determine if the endpoints are available.
• WP_Ajax_Upgrader_Skin::__construct()Constructor.
• Plugin_Upgrader::__construct()
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

273	public function create_item( $request ) {274		global $wp_filesystem;275 276		require_once ABSPATH . 'wp-admin/includes/file.php';277		require_once ABSPATH . 'wp-admin/includes/plugin.php';278		require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';279		require_once ABSPATH . 'wp-admin/includes/plugin-install.php';280 281		$slug = $request['slug'];282 283		// Verify filesystem is accessible first.284		$filesystem_available = $this->is_filesystem_available();285		if ( is_wp_error( $filesystem_available ) ) {286			return $filesystem_available;287		}288 289		$api = plugins_api(290			'plugin_information',291			array(292				'slug'   => $slug,293				'fields' => array(294					'sections'       => false,295					'language_packs' => true,296				),297			)298		);299 300		if ( is_wp_error( $api ) ) {301			if ( str_contains( $api->get_error_message(), 'Plugin not found.' ) ) {302				$api->add_data( array( 'status' => 404 ) );303			} else {304				$api->add_data( array( 'status' => 500 ) );305			}306 307			return $api;308		}309 310		$skin     = new WP_Ajax_Upgrader_Skin();311		$upgrader = new Plugin_Upgrader( $skin );312 313		$result = $upgrader->install( $api->download_link );314 315		if ( is_wp_error( $result ) ) {316			$result->add_data( array( 'status' => 500 ) );317 318			return $result;319		}320 321		// This should be the same as $result above.322		if ( is_wp_error( $skin->result ) ) {323			$skin->result->add_data( array( 'status' => 500 ) );324 325			return $skin->result;326		}327 328		if ( $skin->get_errors()->has_errors() ) {329			$error = $skin->get_errors();330			$error->add_data( array( 'status' => 500 ) );331 332			return $error;333		}334 335		if ( is_null( $result ) ) {336			// Pass through the error from WP_Filesystem if one was raised.337			if ( $wp_filesystem instanceof WP_Filesystem_Base338				&& is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors()339			) {340				return new WP_Error(341					'unable_to_connect_to_filesystem',342					$wp_filesystem->errors->get_error_message(),343					array( 'status' => 500 )344				);345			}346 347			return new WP_Error(348				'unable_to_connect_to_filesystem',349				__( 'Unable to connect to the filesystem. Please confirm your credentials.' ),350				array( 'status' => 500 )351			);352		}

Changelog

Introduced in 5.5.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.9.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.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.