plugin_basename( string $file ): string

Gets the basename of a plugin.

Contents

Description

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

Top ↑

Parameters

$file string Required
The filename of plugin.

Top ↑

Return

string The name of a plugin.

Top ↑

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.

Top ↑

Source

File: wp-includes/plugin.php. View all references 

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 ( str_starts_with( $file, $realdir ) ) {
			$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;
}

View on Trac View on GitHub

Top ↑

Top ↑

Used By

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

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

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

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

Handles deleting a plugin via AJAX.
wp_ajax_update_plugin() wp-admin/includes/ajax-actions.php

Handles updating a plugin via AJAX.
is_uninstallable_plugin() wp-admin/includes/plugin.php

Determines whether the plugin can be uninstalled.
uninstall_plugin() wp-admin/includes/plugin.php

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

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

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

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

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

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

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

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

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

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

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

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

Sets the uninstallation hook for a plugin.
Show 14 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 7You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    If your plugin file is located at /home/www/wp-content/plugins/wpdocs-plugin/wpdocs-plugin.php, and you call:

    $x = plugin_basename( __FILE__ );

    The $x variable will equal to “wpdocs-plugin/wpdocs-plugin.php”.

  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
    Contributed by Brad Davis —

    If you need to access a directory within your awesome plugin, eg, a class directory, you can access it by:

    $class_dir = trailingslashit( dirname( plugin_basename( __FILE__ ) ) ) . '/class';

    $lang_dir variable will now be “your-awesome-plugin/class”, you can now use this to reference files within the class directory.

  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
    Contributed by Niloy —

    If you want to add a plugin action link but need to use the callback action from another file or class than you can try this way

    if ( ! defined( 'WPDOCS_PLUGIN_BASE' ) ) {
        // in main plugin file 
        define( 'WPDOCS_PLUGIN_BASE', plugin_basename( __FILE__ ) );
}

    And now in other file you can easily use this contrast 

    add_filter( 'plugin_action_links_' . WPDOCS_PLUGIN_BASE, 'wpdocs_plugin_settings_link' );

function wpdocs_plugin_settings_link( $links ) { 
        $row_meta = array(
        	'settings' => '<a href="' . esc_attr( get_admin_url( null, 'admin.php?page=wpdocs-settings' ) . '">' . __( 'Settings' ) . '</a>',
        );
        
        return array_merge( $links, $row_meta );
}

    so it is good practice to define a CONSTANT for plugin_basename( __FILE__ ) and reuse it again.

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