plugin_basename( string $file )

Gets the basename of a plugin.

Contents

Description Description

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

Parameters Parameters

$file

(string) (Required) The filename of plugin.

Top ↑

Return Return

(string) The name of a plugin.

Top ↑

Source Source

File: wp-includes/plugin.php

666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
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 );
 
    $file = preg_replace( '#^' . preg_quote( $plugin_dir, '#' ) . '/|^' . preg_quote( $mu_plugin_dir, '#' ) . '/#', '', $file ); // get relative path from plugins dir
    $file = trim( $file, '/' );
    return $file;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
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: activate_plugin()

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

Deactivate a single plugin or multiple plugins.
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.
Show 11 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You 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:

    1
    $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.

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