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

Parses the plugin contents to retrieve plugin’s metadata.


Description Description

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.


Parameters Parameters

$plugin_file

(string) (Required) Absolute path to the main plugin file.

$markup

(bool) (Optional) If the returned data should have HTML markup applied.

Default value: true

$translate

(bool) (Optional) If the returned data should be translated.

Default value: true


Top ↑

Return Return

(array) Plugin data. Values will be empty if not supplied by the plugin.

  • 'Name'
    (string) Name of the plugin. Should be unique.
  • 'Title'
    (string) Title of the plugin and link to the plugin's site (if set).
  • 'Description'
    (string) Plugin description.
  • 'Author'
    (string) Author's name.
  • 'AuthorURI'
    (string) Author's website address (if set).
  • 'Version'
    (string) Plugin version.
  • 'TextDomain'
    (string) Plugin textdomain.
  • 'DomainPath'
    (string) Plugins relative directory path to .mo files.
  • 'Network'
    (bool) Whether the plugin can only be activated network-wide.
  • 'RequiresWP'
    (string) Minimum required version of WordPress.
  • 'RequiresPHP'
    (string) Minimum required version of PHP.


Top ↑

Source Source

File: wp-admin/includes/plugin.php

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',
		'RequiresWP'  => 'Requires at least',
		'RequiresPHP' => 'Requires PHP',
		// 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'] ) {
		/* translators: 1: Site Wide Only: true, 2: Network: true */
		_deprecated_argument( __FUNCTION__, '3.0.0', sprintf( __( 'The %1$s plugin header is deprecated. Use %2$s instead.' ), '<code>Site Wide Only: true</code>', '<code>Network: true</code>' ) );
		$plugin_data['Network'] = $plugin_data['_sitewide'];
	}
	$plugin_data['Network'] = ( 'true' == strtolower( $plugin_data['Network'] ) );
	unset( $plugin_data['_sitewide'] );

	// If no text domain is defined fall back to the plugin slug.
	if ( ! $plugin_data['TextDomain'] ) {
		$plugin_slug = dirname( plugin_basename( $plugin_file ) );
		if ( '.' !== $plugin_slug && false === strpos( $plugin_slug, '/' ) ) {
			$plugin_data['TextDomain'] = $plugin_slug;
		}
	}

	if ( $markup || $translate ) {
		$plugin_data = _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup, $translate );
	} else {
		$plugin_data['Title']      = $plugin_data['Name'];
		$plugin_data['AuthorName'] = $plugin_data['Author'];
	}

	return $plugin_data;
}

Top ↑

Changelog Changelog

Changelog
Version Description
5.3.0 Added support for Requires at least and Requires PHP headers.
1.5.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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