plugin_basename()

💡 云策文档标注

概述

plugin_basename() 函数用于获取插件相对于插件目录的基名，去除前导和尾随斜杠。它内部使用 WP_PLUGIN_DIR 和 WPMU_PLUGIN_DIR 常量来提取路径，但直接使用这些常量不推荐。

关键要点

函数功能：从插件文件名中提取插件基名，返回相对于插件目录的路径。
参数：$file（字符串，必需），插件文件名。
返回值：字符串，插件基名。
内部处理：使用 wp_normalize_path() 规范化路径，并处理 $wp_plugin_paths 全局变量以支持路径映射。
注意事项：直接使用 WordPress 内部常量（如 WP_PLUGIN_DIR）不推荐，应通过此函数间接使用。

代码示例

// 示例：获取当前插件文件的基名
$x = plugin_basename( __FILE__ );
// 如果插件文件位于 /wp-content/plugins/wpdocs-plugin/wpdocs-plugin.php
// $x 将等于 "wpdocs-plugin/wpdocs-plugin.php"

注意事项

对于单文件插件或 must-use 插件，plugin_basename( __FILE__ ) 可能返回与 basename( __FILE__ ) 相同的值，但在子目录中不同。
建议定义常量（如 WPDOCS_PLUGIN_BASE）来存储 plugin_basename( __FILE__ ) 的结果，以便在插件其他部分重用。

📄 原文内容

Gets the basename of a plugin.

Description

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

Parameters

$filestringrequired: The filename of plugin.

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

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 all references View on Trac View on GitHub

Uses	Description
wp_normalize_path()`wp-includes/functions.php`	Normalizes a filesystem path.

Used by	Description
WP_REST_Templates_Controller::get_wp_templates_author_text_field()`wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php`	Returns a human readable text for the author of the template.
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 15 more Show less

Changelog

Version	Description
1.5.0	Introduced.

User Contributed Notes

Skip to note 4 content

Codex

11 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 8You must log in to vote on the helpfulness of this note
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”.
- For a plugin that consist of just a PHP file (e.g. wp-content/plugin.php) and for a must-use plugin (e.g. wp-content/mu-plugins/plugin.php), plugin_basename( __FILE__ ) returns plugin.php. Note that in these particular contexts, plugin_basename( __FILE__ ) and basename( __FILE__ ) return the same value. However these functions are not equivalent for plugin files residing inside a subdirectory.
  
  Bart Kuijper 6 years ago
Log in to add feedback
Skip to note 5 content

Brad Davis

7 years ago

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
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.
Log in to add feedback

Skip to note 6 content

Niloy – Codeixer

6 years ago

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.

云策 WordPress 开发者社区

函数文档