W3cubDocs

/WordPress

plugin_basename( string $file )

Gets the basename of a plugin.

Description

This method extracts the name of a plugin from its filename.

Parameters

$file

(string) (Required) The filename of plugin.

Return

(string) The name of a plugin.

More Information

This function gets the path to a plugin file or directory, relative to the plugins directory, without the leading and trailing slashes.
Uses both the WP_PLUGIN_DIR and WPMU_PLUGIN_DIR constants internally, to test for and strip the plugins directory path from the $file path. Note that the direct usage of WordPress internal constants is not recommended.

Source

File: wp-includes/plugin.php 

function plugin_basename( $file ) {
	global $wp_plugin_paths;

	// $wp_plugin_paths contains normalized paths.
	$file = wp_normalize_path( $file );

	arsort( $wp_plugin_paths );
	foreach ( $wp_plugin_paths as $dir => $realdir ) {
		if ( strpos( $file, $realdir ) === 0 ) {
			$file = $dir . substr( $file, strlen( $realdir ) );
		}
	}

	$plugin_dir    = wp_normalize_path( WP_PLUGIN_DIR );
	$mu_plugin_dir = wp_normalize_path( WPMU_PLUGIN_DIR );

	// Get relative path from plugins directory.
	$file = preg_replace( '#^' . preg_quote( $plugin_dir, '#' ) . '/|^' . preg_quote( $mu_plugin_dir, '#' ) . '/#', '', $file );
	$file = trim( $file, '/' );
	return $file;
}

Uses

Uses Description
wp-includes/functions.php: wp_normalize_path()

Normalize a filesystem path.

Used By

Used By Description
wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php: WP_REST_Plugins_Controller::validate_plugin_param()

Checks that the “plugin” parameter is a valid path.
wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php: WP_REST_Plugins_Controller::sanitize_plugin_param()

Sanitizes the “plugin” parameter to be a proper plugin file with “.php” appended.
wp-includes/load.php: wp_skip_paused_plugins()

Filters a given list of plugins, removing any paused plugins from it.
wp-admin/includes/ajax-actions.php: wp_ajax_delete_plugin()

Ajax handler for deleting a plugin.
wp-admin/includes/ajax-actions.php: wp_ajax_update_plugin()

Ajax handler for updating a plugin.
wp-admin/includes/plugin.php: is_uninstallable_plugin()

Whether the plugin can be uninstalled.
wp-admin/includes/plugin.php: uninstall_plugin()

Uninstall a single plugin.
wp-admin/includes/plugin.php: add_menu_page()

Add a top-level menu page.
wp-admin/includes/plugin.php: add_submenu_page()

Add a submenu page.
wp-admin/includes/plugin.php: deactivate_plugins()

Deactivate a single plugin or multiple plugins.
wp-admin/includes/plugin.php: activate_plugin()

Attempts activation of plugin in a “sandbox” and redirects on success.
wp-admin/includes/plugin.php: get_plugin_data()

Parses the plugin contents to retrieve plugin’s metadata.
wp-admin/includes/plugin.php: _get_plugin_data_markup_translate()

Sanitizes plugin data, optionally adds markup, optionally translates.
wp-admin/includes/plugin.php: get_plugin_files()

Get a list of a plugin’s files.
wp-admin/includes/plugin.php: get_plugins()

Check the plugins directory and retrieve all plugin files with plugin data.
wp-includes/link-template.php: plugins_url()

Retrieves a URL within the plugins or mu-plugins directory.
wp-includes/plugin.php: register_activation_hook()

Set the activation hook for a plugin.
wp-includes/plugin.php: register_deactivation_hook()

Set the deactivation hook for a plugin.
wp-includes/plugin.php: register_uninstall_hook()

Set the uninstallation hook for a plugin.

Changelog

Version Description
1.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/plugin_basename