Parse the plugin contents to retrieve plugin’s metadata.

The metadata of the plugin’s data searches for the following in the plugin’s header. All plugin data must be on its own line. For plugin description, it must not have any newlines or only parts of the description will be displayed and the same goes for the plugin data. The below is formatted for printing.

Plugin Name: Name of Plugin Plugin URI: Link to plugin information Description: Plugin Description Author: Plugin author's name Author URI: Link to the author's web site Version: Must be set in the plugin for WordPress 2.3+ Text Domain: Optional. Unique identifier, should be same as the one used in plugin_text_domain() 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. / # Remove the space to close comment

Plugin data returned array contains the following: ‘Name’ – Name of the plugin, must be unique. ‘Title’ – Title of the plugin and the link to the plugin’s web site. ‘Description’ – Description of what the plugin does and/or notes from the author. ‘Author’ – The author’s name ‘AuthorURI’ – The authors web site address. ‘Version’ – The plugin version number. ‘PluginURI’ – Plugin web site address. ‘TextDomain’ – Plugin’s text domain for localization. ‘DomainPath’ – Plugin’s relative directory path to .mo files. ‘Network’ – Boolean. Whether the plugin can only be activated network wide.

Some users have issues with opening large files and manipulating the contents for want is usually the first 1kiB or 2kiB. This function stops pulling in the plugin contents when it has all of the required plugin data.

The first 8kiB of the file will be pulled in and if the plugin data is not within that first 8kiB, 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.

Signature

get_plugin_data( $plugin_file, $markup = true, $translate = true )
plugin_file
 (string) Path to the plugin file
markup
 (boolean) Optional. If the returned data should have HTML markup applied. Defaults to true.
Default: true
translate
 (boolean) Optional. If the returned data should be translated. Defaults to true.
Default: true

Return

(array) See above for description.

Source

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

	$default_headers = array(
		'Name' => 'Plugin Name',
		'PluginURI' => 'Plugin URI',
		'Version' => 'Version',
		'Description' => 'Description',
		'Author' => 'Author',
		'AuthorURI' => 'Author URI',
		'TextDomain' => 'Text Domain',
		'DomainPath' => 'Domain Path',
		'Network' => 'Network',
		// Site Wide Only is deprecated in favor of Network.
		'_sitewide' => 'Site Wide Only',
	);

	$plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );

	// Site Wide Only is the old header for Network
	if ( ! $plugin_data['Network'] && $plugin_data['_sitewide'] ) {
15 more lines...
WP Trac GitHub

Link here