WP_REST_Plugins_Controller::get_plugin_data() WordPress Method

The WP_REST_Plugins_Controller::get_plugin_data() method is used to retrieve the data for a plugin. This data includes the plugin name, plugin slug, and plugin version.

WP_REST_Plugins_Controller::get_plugin_data( string $plugin ) #

Gets the plugin header data for a plugin.

Contents

Parameters

$plugin

(string)(Required)The plugin file to get data for.

Top ↑

Return

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

Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

641
642
643
644
645
646
647
648
649
650
651
652
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;
}

Expand full source codeCollapse full source codeView on TracView on GitHub

Top ↑

Top ↑

Uses

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

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

wp-includes/l10n.php:__()

Retrieve the translation of $text.

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

Initializes the error.

Top ↑

Changelog

Changelog
VersionDescription
5.5.0Introduced.
Download the latest version of WordPress from https://wordpress.org/

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by the Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.