get_plugin_data() – Parses the plugin contents to retrieve plugin’s metadata.

You appear to be a bot. Output may be restricted

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.

Usage

$array = get_plugin_data( $plugin_file, $markup, $translate );

Parameters

$plugin_file
( string ) required – Absolute path to the main plugin file.
$markup
( bool ) optional default: 1 – Optional. If the returned data should have HTML markup applied. Default true.
$translate
( bool ) optional default: 1 – Optional. If the returned data should be translated. Default true.
$Name
( string ) optional default: 1 – Name of the plugin. Should be unique.
$PluginURI
( string ) optional default: 1 – Plugin URI.
$Version
( string ) optional default: 1 – Plugin version.
$Description
( string ) optional default: 1 – Plugin description.
$Author
( string ) optional default: 1 – Plugin author's name.
$AuthorURI
( string ) optional default: 1 – Plugin author's website address (if set).
$TextDomain
( string ) optional default: 1 – Plugin textdomain.
$DomainPath
( string ) optional default: 1 – Plugin's relative directory path to .mo files.
$Network
( bool ) optional default: 1 – Whether the plugin can only be activated network-wide.
$RequiresWP
( string ) optional default: 1 – Minimum required version of WordPress.
$RequiresPHP
( string ) optional default: 1 – Minimum required version of PHP.
$UpdateURI
( string ) optional default: 1 – ID of the plugin for update purposes, should be a URI.
$Title
( string ) optional default: 1 – Title of the plugin and link to the plugin's site (if set).
$AuthorName
( string ) optional default: 1 – Plugin author's name. }

Returns

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

Source

File name: wordpress/wp-admin/includes/plugin.php
Lines:

1 to 47 of 47
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',
    'UpdateURI'   => 'Update URI',
    // 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( get_plugin_data, '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;
}
 

 View on GitHub View on Trac