菜鸟笔记
提升您的技术认知

wordpress各种获取路径和URL地址的函数总结

wordpress中的路径也不是很负责,有人为了让wordpress运行速度更快,就直接写了绝对地址,其实这样是很不好的,有可能别人修改了wordpress程序的地址,那么这样你编写的这个插件或者是主题就只有你自己用,别人无法使用,这样做得不偿失,为了避免错误,了解WordPress中与获取路径相关的函数很重要。

以下均假设WordPress站点安装在https://www.coonote.com下。

站点路径相关函数

home_url()

返回站点路径,相当于后台设置->常规中的”站点地址(URL)”。

$url = home_url();
echo $url;
//输出: https://www.coonote.com

$url = home_url('/images/');
echo $url;
//输出:https://www.coonote.com/images/

site_url()

如果WordPress安装在域名根目录下,则该函数与home_url()相同。

如果WordPress安装在子目录下,例如https://www.coonote.com/,则site_url()返回WordPress实际安装地址,相当于后台->设置->常规中的“WordPress 地址(URL)”。

$url = site_url();
echo $url;
//假设WordPress安装在https://www.coonote.com下
//输出:https://www.coonote.com
admin_url()
返回后台地址,传递参数后也可返回后台menu的地址

$url = admin_url();
echo $url;
//输出:https://www.coonote.com/wp-admin/
content_url()

返回实际的wp-content目录,如果是默认安装,且装在根目录下,则如下所示

$url = content_url();
echo $url;
//输出:https://www.coonote.com/wp-content
如果在wp-config.php中改变了wp-content目录的位置,则该函数会返回正确地址,例如wp-config.php中如下定义

define('WP_CONTENT_DIR','/home/user/public_html/cdn');
define('WP_CONTENT_URL','http://www.coonote.com');
则content_url()的返回值为

www.coonote.com

includes_url()

返回当前WordPress站点存放核心文件的目录wp-includes的地址,可以带一个$path作为参数。

$url = includes_url( '/js/');
echo $url;
//输出:https://www.coonote.com/wp-includes/js/
wp_upload_dir()
返回WordPress上传目录的地址,是一个数组,包含一系列与上传地址相关的信息。


提供如下信息给你

‘path’ – 上传目录的服务器绝对路径,通常以反斜杠(/)开头
‘url’ – 上传目录的完整URL
‘subdir’ – 子目录名称,通常是以年/月形式组织的目录地址,例如/2012/07
‘basedir’ – 上传目录的服务器绝对路径,不包含子目录
‘baseurl’ – 上传目录的完整URL,不包含子目录
‘error’ – 报错信息.
例如

$upload_dir = wp_upload_dir();
echo $upload_dir['baseurl'];
//输出:https://www.coonote.com/wp-content/uploads

主题路径相关函数

get_theme_root_uri()
获取存放主题的目录URI

echo get_theme_root_uri();
//输出:https://www.coonote.com/wp-content/themes
get_theme_root()
获取存放主题的目录的服务器绝对路径

echo get_theme_root();
//输出:/home/user/public_html/wp-content/themes
get_theme_roots()
获取主题目录的目录名称,如果你的主题目录是/wp-content/themes,则

echo get_theme_roots();
//输出:/themes
get_stylesheet_directory()
获取当前启用的主题目录的服务器绝对路径,例如

/home/user/public_html/wp-content/themes/twentyeleven
可以用来include文件,例如

get_stylesheet_directory_uri()
获取当前启用的主题目录的URI,例如

echo get_stylesheet_directory_uri();
//输出:https://www.coonote.com/wp-content/themes/twentyeleven
可以使用在需要主题目录URI的场合,例如图片


get_template_directory_uri()
如果当前启用的主题是一个child theme,该函数返回parent theme的主题目录URI,用法与get_stylesheet_directory_uri()类似。

get_template_directory()
如果当前启用的主题是一个child theme,该函数返回parent theme的主题目录的服务器绝对路径,用法与get_stylesheet_directory()类似。

get_template()
获取当前启用主题的主题目录名称,例如现在启用的主题为twentyeleven,则

echo get_stylesheet();
//输出:twentyeleven
get_stylesheet()

获取当前启用主题的主题目录名称,与get_template()的区别是,如果用了child theme,则返回child theme的目录名称。

插件路径相关函数

plugins_url()
获取当前插件的目录的URI,例如一个插件位于/wp-content/plugins/myplugin下,该目录下放有插件的主文件名为myplugin.php,在myplugin.php中执行下面的代码,结果如下

echo plugins_url();
//输出:https://www.coonote.com/wp-content/plugins

echo plugins_url('',FILE);
//输出:https://www.coonote.com/wp-content/plugins/myplugin

echo plugins_url('js/myscript.js',FILE);
//输出:https://www.coonote.com/wp-content/plugins/myplugin/js/myscript.js
plugin_dir_url()
返回当前插件的目录URI,例如

echo plugin_dir_url(FILE );
//输出:https://www.coonote.com/wp-content/plugins/myplugin/
注意结尾有反斜杠。

plugin_dir_path()
返回当前插件目录的服务器绝对路径,例如

echo plugin_dir_path(FILE );
//输出:/home/user/public_html/wp-content/plugins/myplugin/
可以用来引用文件,例如


plugin_basename()
返回调用该函数的插件文件名称(包含插件路径)

例如在插件myplugin下的myplugin.php文件中调用该函数,结果如下

echo plugin_basename(FILE);
//输出:myplugin/myplugin.php

如果在myplugin/include/test.php文件中调用(test.php通过include引用到myplugin.php中),结果如下

echo plugin_basename(FILE);
//输出:myplugin/include/test.php

路径相关常量

WordPress中还有一组用define定义的常量代表路径。

WP_CONTENT_DIR

wp-content目录的服务器绝对路径,例如

/home/user/public_html/wp-content

WP_CONTENT_URL

wp-content目录的URI地址,例如

https://www.coonote.com/wp-content

WP_PLUGIN_DIR

插件目录的服务器绝对路径,例如

/home/user/public_html/wp-content/plugins
WP_PLUGIN_URL

插件目录的URI地址,例如

https://www.coonote.com/wp-content/plugins

TEMPLATEPATH

当前启用主题目录的服务器绝对路径,相当于get_template_directory()例如

/home/user/public_html/wp-content/themes/twentyeleven
STYLESHEETPATH
当前启用主题目录的服务器绝对路径,相当于get_stylesheet_directory(),与TEMPLATEPATH的区别在于如果使用child theme,该常量指向child theme目录。