WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Plugins_Controller::get_plugin_data()

WP_REST_Plugins_Controller::get_plugin_data( string $plugin ): array|WP_Error

In this article

Back to top

Gets the plugin header data for a plugin.

Parameters

$pluginstringrequired
The plugin file to get data for.

Return

array|WP_Error The plugin data, or a WP_Error if the plugin is not installed.

Source

protected function get_plugin_data( $plugin ) {
	$plugins = get_plugins();

	if ( ! isset( $plugins[ $plugin ] ) ) {
		return new WP_Error( 'rest_plugin_not_found', __( 'Plugin not found.' ), array( 'status' => 404 ) );
	}

	$data          = $plugins[ $plugin ];
	$data['_file'] = $plugin;

	return $data;
}

View all references View on Trac View on GitHub

UsesDescription
get_plugins()wp-admin/includes/plugin.php

Checks the plugins directory and retrieve all plugin files with plugin data.

__()wp-includes/l10n.php

Retrieves the translation of $text.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 1 moreShow less
Used byDescription
WP_REST_Plugins_Controller::get_item()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Retrieves one plugin from the site.

WP_REST_Plugins_Controller::update_item()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Updates one plugin.

WP_REST_Plugins_Controller::delete_item()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Deletes one plugin from the site.

Changelog

VersionDescription
5.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.