get_plugin_data


get_plugin_data ( $plugin_file, $markup = true, $translate = true )

Parameters:
  • (string) plugin_file Absolute path to the main plugin file.
  • (bool) markup Optional. If the returned data should have HTML markup applied. Default true.
  • (bool) translate Optional. If the returned data should be translated. Default true.
Returns:
  • (array) { Plugin data. Values will be empty if not supplied by the plugin. @type string $Name Name of the plugin. Should be unique. @type string $Title Title of the plugin and link to the plugin's site (if set). @type string $Description Plugin description. @type string $Author Author's name. @type string $AuthorURI Author's website address (if set). @type string $Version Plugin version. @type string $TextDomain Plugin textdomain. @type string $DomainPath Plugins relative directory path to .mo files. @type bool $Network Whether the plugin can only be activated network-wide. @type string $RequiresWP Minimum required version of WordPress. @type string $RequiresPHP Minimum required version of PHP. }
Defined at:
Change Log:
  • 5: .

Description

Parses the plugin contents to retrieve plugin's metadata.All plugin headers must be on their own line. Plugin description must not have any newlines, otherwise only parts of the description will be displayed. The below is formatted for printing. /* Plugin Name: Name of the plugin. Plugin URI: The home page of the plugin. Description: Plugin description. Author: Plugin author's name. Author URI: Link to the author's website. Version: Plugin version. Text Domain: Optional. Unique identifier, should be same as the one used in load_plugin_textdomain(). Domain Path: Optional. Only useful if the translations are located in a folder above the plugin's base path. For example, if .mo files are located in the locale folder then Domain Path will be "/locale/" and must have the first slash. Defaults to the base folder the plugin is located in. Network: Optional. Specify "Network: true" to require that a plugin is activated across all sites in an installation. This will prevent a plugin from being activated on a single site when Multisite is enabled. Requires at least: Optional. Specify the minimum required WordPress version. Requires PHP: Optional. Specify the minimum required PHP version. * / # Remove the space to close comment. The first 8 KB of the file will be pulled in and if the plugin data is not within that first 8 KB, then the plugin author should correct their plugin and move the plugin data headers to the top. The plugin file is assumed to have permissions to allow for scripts to read the file. This is not checked however and the file is only opened for reading.

Related Functions

get_plugin_updates, get_plugins, get_inline_data, get_file_data, get_plugin_files

Top Google Results

User discussions

wpseek mobile