描述
如果未提供参数,则默认为插件目录URL。
参数
- $path
-
(string)(可选) 附加到URL末尾的额外路径,如果提供了$plugin,则包括相对目录。
默认值: ''
- $plugin
-
(string)(可选) 插件或mu-plugin中文件的完整路径。URL将相对于其目录。通常,这是通过传递
__FILE__
作为参数来完成的。默认值: ''
返回
(string) 附加可选路径的插件URL链接。
更多信息
此函数检索插件或mu-plugins目录的绝对URL(不带尾随斜杠),或者在使用$path参数时,检索该目录下的特定文件的绝对URL。您可以将$path参数指定为相对于插件或mu-plugins目录的硬编码路径,或者方便地将__FILE__作为第二个参数传递,以使$path相对于当前PHP脚本文件的父目录。
使用WP_PLUGIN_URL,或者在$plugin路径以WPMU_PLUGIN_DIR路径开始的情况下,在内部使用WPMU_PLUGIN_URL常量,来组成结果的URL。注意,不建议直接使用WordPress的内部常量。
使用apply_filters()要在生成的URL上应用“plugins_url”过滤器,请使用以下代码行
return apply_filters( 'plugins_url', $url, $path, $plugin );
该plugins_url()函数不应在插件的全局上下文中调用,而应在如“init”或“admin_init”钩子,以确保在调用函数时“plugins_url”过滤器已挂接。这对于许多站点配置的工作至关重要,如果plugins_url()在插件文件的全局上下文中调用。它不能被其他插件过滤(尽管mu-plugins能够过滤它,因为它们在任何其他插件之前运行)。
源码
更新日志
版本 | 描述 |
---|---|
2.6.0 | 开始引入 |
使用示例
常见用法
plugins_url()
函数通常用于插件文件中。在$plugin
参数的位置传递__FILE__
PHP魔法常数,使$path
相对于该文件的父目录:echo '<img src="' . esc_url( plugins_url( 'images/wordpress.png', __FILE__ ) ) . '" > ';
以上内容可能会输出此HTML标记:
<img src="http://www.example.com/wp-content/plugins/my-plugin/images/wordpress.png">
。如果在嵌套在插件目录子目录中的文件中使用
plugins_url()
函数,则应使用PHP的dirname()
功能:echo '<img src="' . esc_url( plugins_url( 'images/wordpress.png', dirname(__FILE__) ) ) . '" > ';
以上内容可能会输出此HTML标记:
<img src="http://www.example.com/wp-content/plugins/images/wordpress.png">
。默认用法
$plugins_url = plugins_url();
$plugins_url
变量将等于plugins
或mu-plugins
目录的绝对URL,例如:“http://www.example.com/wp-content/plugins”