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

Description

Parameters

$plugin_filestring

Absolute path to the main plugin file.

$markupbooloptional

If the returned data should have HTML markup applied. Default true.Default: true

$translatebooloptional

If the returned data should be translated. Default true.Default: true

Return

array

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

• $Namestring

  Name of the plugin. Should be unique.

• $PluginURIstring

  Plugin URI.

• $Versionstring

  Plugin version.

• $Descriptionstring

  Plugin description.

• $Authorstring

  Plugin author's name.

• $AuthorURIstring

  Plugin author's website address (if set).

• $TextDomainstring

  Plugin textdomain.

• $DomainPathstring

  Plugin's relative directory path to .mo files.

• $Networkbool

  Whether the plugin can only be activated network-wide.

• $RequiresWPstring

  Minimum required version of WordPress.

• $RequiresPHPstring

  Minimum required version of PHP.

• $UpdateURIstring

  ID of the plugin for update purposes, should be a URI.

• $RequiresPluginsstring

  Comma separated list of dot org plugin slugs.

• $Titlestring

  Title of the plugin and link to the plugin's site (if set).

• $AuthorNamestring

  Plugin author's name.

Uses · 6

• get_file_data()Retrieves metadata from a file.
• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• __()Retrieves the translation of $text.
• plugin_basename()Gets the basename of a plugin.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• _get_plugin_data_markup_translate()Sanitizes plugin data, optionally adds markup, optionally translates.

Used by · 12

• Plugin_Upgrader::bulk_upgrade()Upgrades several plugins at once.
• Plugin_Upgrader::check_package()Checks that the source package contains a valid plugin.
• WP_Automatic_Updater::update()Updates an item, if appropriate.
• WP_REST_Plugins_Controller::create_item()Uploads a plugin and optionally activates it.
• WP_REST_Templates_Controller::get_wp_templates_author_text_field()Returns a human readable text for the author of the template.
• get_dropins()Checks the wp-content directory and retrieve all drop-ins with any plugin data.
• get_mu_plugins()Checks the mu-plugins directory and retrieve all mu-plugin files with any plugin data.
• get_plugins()Checks the plugins directory and retrieve all plugin files with plugin data.
• is_network_only_plugin()Checks for "Network: true" in the plugin header to see if this should be activated only as a network wide plugin. The plugin would also work when Multisite is not enabled.
• validate_plugin_requirements()Validates the plugin requirements for WordPress version and PHP version.
• wp_ajax_delete_plugin()Handles deleting a plugin via AJAX.
• wp_ajax_update_plugin()Handles updating a plugin via AJAX.

Source

View on Trac ↗View on GitHub ↗

74function get_plugin_data( $plugin_file, $markup = true, $translate = true ) {75 76	$default_headers = array(77		'Name'            => 'Plugin Name',78		'PluginURI'       => 'Plugin URI',79		'Version'         => 'Version',80		'Description'     => 'Description',81		'Author'          => 'Author',82		'AuthorURI'       => 'Author URI',83		'TextDomain'      => 'Text Domain',84		'DomainPath'      => 'Domain Path',85		'Network'         => 'Network',86		'RequiresWP'      => 'Requires at least',87		'RequiresPHP'     => 'Requires PHP',88		'UpdateURI'       => 'Update URI',89		'RequiresPlugins' => 'Requires Plugins',90		// Site Wide Only is deprecated in favor of Network.91		'_sitewide'       => 'Site Wide Only',92	);93 94	$plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );95 96	// Site Wide Only is the old header for Network.97	if ( ! $plugin_data['Network'] && $plugin_data['_sitewide'] ) {98		/* translators: 1: Site Wide Only: true, 2: Network: true */99		_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>' ) );100		$plugin_data['Network'] = $plugin_data['_sitewide'];101	}102	$plugin_data['Network'] = ( 'true' === strtolower( $plugin_data['Network'] ) );103	unset( $plugin_data['_sitewide'] );104 105	// If no text domain is defined fall back to the plugin slug.106	if ( ! $plugin_data['TextDomain'] ) {107		$plugin_slug = dirname( plugin_basename( $plugin_file ) );108		if ( '.' !== $plugin_slug && ! str_contains( $plugin_slug, '/' ) ) {109			$plugin_data['TextDomain'] = $plugin_slug;110		}111	}112 113	if ( $markup || $translate ) {114		$plugin_data = _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup, $translate );115	} else {116		$plugin_data['Title']      = $plugin_data['Name'];117		$plugin_data['AuthorName'] = $plugin_data['Author'];118	}119 120	return $plugin_data;121}

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-admin/includes/plugin.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.