现在的位置:首页>wordpress>正文

WordPress与路径相关的函数大全

2016年11月03日 ⁄ 共 4554字 评论 2 条

作为一个经常折腾WordPress的同学来说,我们经常使用的函数可能就是各种WordPress路径函数了。比如获得根目录之类的,我们会经常要用到,这里部落收集了WordPress与路径相关的函数,一起来看看。

与WordPress打交道,经常遇到的一个问题就是获取路径,包括URL路径和服务器路径,在主题或插件中引用js或css文件需要URL地址,而include一些文件时则需要服务器路径。在WordPress中,不能认定wp-content目录一定位于/wp-content下,也不能认为admin的地址一定是/wp-admin,为了避免错误,了解WordPress中与获取路径相关的函数很重要。

站点路径相关函数

home_url()

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

  1. $url = home_url();
  2. echo $url;
  3. //输出: http://www.mfbuluo.com
  4. $url = home_url('/images/');
  5. echo $url;
  6. 输出:http://www.mfbuluo.com/images/

site_url()

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

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

  1. $url = site_url();
  2. echo $url;
  3. //假设WordPress安装在http://www.mfbuluo.com/wordpress下
  4. //输出:http://www.mfbuluo.com/wordpress

admin_url()

返回后台地址,传递参数后也可返回后台menu的地址

  1. $url = admin_url();
  2. echo $url;
  3. //输出:http://www.mfbuluo.com/wp-admin/

content_url()

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

  1. $url = content_url();
  2. echo $url;
  3. //输出:http://www.mfbuluo.com/wp-content

如果在wp-config.php中改变了wp-content目录的位置,则该函数会返回正确地址,例如wp-config.php中如下定义:

  1. define('WP_CONTENT_DIR', '/home/user/public_html/cdn');
  2. define('WP_CONTENT_URL', 'http://sola-cdn.me');

则content_url()的返回值为:

  1. http://bbs.mfbuluo.com

includes_url()

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

  1. $url = includes_url( '/js/');
  2. echo $url;
  3. //输出:http://www.mfbuluo.com/wp-includes/js/

wp_upload_dir()

返回WordPress上传目录的地址,是一个数组,包含一系列与上传地址相关的信息。

  1. <?php $upload_dir = wp_upload_dir(); ?>

相关的信息如下:

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

例如:

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

主题路径相关函数

get_theme_root_uri()

获取存放主题的目录URI

  1. echo get_theme_root_uri();
  2. //输出:http://www.mfbuluo.com/wp-content/themes

get_theme_root()

获取存放主题的目录的服务器绝对路径:

  1. echo get_theme_root();
  2. //输出:<tt>/home/user/public_html/wp-content/themes</tt>

get_theme_roots()

获取主题目录的目录名称,如果你的主题目录是/wp-content/themes,则:

  1. echo get_theme_roots();
  2. //输出:/themes

get_stylesheet_directory()

获取当前启用的主题目录的服务器绝对路径,例如:

/home/user/public_html/wp-content/themes/twentyeleven

可以用来include文件,例如:

  1. <?php include( get_stylesheet_directory() . '/includes/myfile.php'); ?>

get_stylesheet_directory_uri()

获取当前启用的主题目录的URI,例如:

  1. echo get_stylesheet_directory_uri();
  2. //输出:http://www.mfbuluo.com/wp-content/themes/twentyeleven

可以使用在需要主题目录URI的场合,例如图片:

  1. <img src="<?php echo get_stylesheet_directory_uri() ?>/images/aternus.png" alt="" title="" width="" height="" />


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,则

  1. echo get_stylesheet();
  2. //输出:twentyeleven

get_stylesheet()

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

插件路径相关函数

plugins_url()

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

  1. echo plugins_url();
  2. //输出:http://www.mfbuluo.com/wp-content/plugins
  3. echo plugins_url('',__FILE__);
  4. //输出:http://www.mfbuluo.com/wp-content/plugins/myplugin
  5. echo plugins_url('js/myscript.js',__FILE__);
  6. //输出:http://www.mfbuluo.com/wp-content/plugins/myplugin/js/myscript.js

plugin_dir_url()

返回当前插件的目录URI,例如

  1. echo plugin_dir_url( __FILE__ );
  2. //输出:http://www.mfbuluo.com/wp-content/plugins/myplugin/

注意结尾有反斜杠。

plugin_dir_path()

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

  1. echo plugin_dir_path( __FILE__ );
  2. //输出:/home/user/public_html/wp-content/plugins/myplugin/

可以用来引用文件,例如

  1. <?php
  2. define( 'MYPLUGINNAME_PATH', plugin_dir_path(__FILE__) );
  3. require MYPLUGINNAME_PATH . 'includes/class-metabox.php';
  4. require MYPLUGINNAME_PATH . 'includes/class-widget.php';
  5. ?>

plugin_basename()

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

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

  1. echo plugin_basename(__FILE__);
  2. //输出:myplugin/myplugin.php

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

  1. echo plugin_basename(__FILE__);
  2. //输出:myplugin/include/test.php

路径相关常量

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

WP_CONTENT_DIR

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

/home/user/public_html/wp-content

WP_CONTENT_URL

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

http://www.mfbuluo.com/wp-content

WP_PLUGIN_DIR

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

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

WP_PLUGIN_URL

插件目录的URI地址,例如

http://www.mfbuluo.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目录。

评论 2 条 评论内容很精采,有内幕,而且绝对有干货

  1. 香港云服务器 2016年11月03日 14:40  @回复  Δ-49楼 回复

    WordPress与路径相关的函数还蛮多的,但是会用的就只有经常用的那几个,大部分是没怎么用的

  2. 沉鱼落雁随笔 2016年11月05日 08:04  @回复  Δ-48楼 回复

    看来我有必要研究一下如何做wordpress了

给我留言