解析 WordPress `get_template_directory()` 和 `get_stylesheet_directory()` 函数的源码：在子主题开发中的应用。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，大家好！今天咱们来聊聊WordPress子主题开发中两个非常重要的函数：get_template_directory() 和 get_stylesheet_directory()。别看名字挺长，其实作用很简单，但用不好，就容易掉进坑里。准备好了吗？咱们开车！

一、开场白：为啥要搞清楚这两个函数？

大家伙儿在搞WordPress主题开发的时候，尤其是子主题，肯定绕不开这两个函数。它们就像导航仪，指引着你的主题文件（CSS、JS、图片等等）的正确方向。搞不清它们，你的主题就可能迷路，轻则样式错乱，重则直接白屏，搞得你怀疑人生。

所以，今天咱们的任务就是：

深入源码：扒开这两个函数的皮，看看它们到底在干啥。
子主题应用：结合子主题的特性，搞明白在什么情况下用哪个函数。
避坑指南：总结一些常见的坑，让大家少走弯路。

二、get_template_directory()：老大哥，指向父主题

顾名思义，get_template_directory() 这个函数的作用就是 获取父主题的目录路径。注意，是目录路径，不是URL。路径是给PHP用的，URL是给浏览器用的。

咱们先来看看它的源码，虽然WordPress的代码风格有时候让人有点抓狂，但核心逻辑还是挺清晰的：

function get_template_directory() {
    static $template_dir = null;

    if ( isset( $template_dir ) ) {
        return $template_dir;
    }

    $template = get_template(); // 获取当前使用的模板名称（父主题）

    /**
     * Filters the absolute path to the current theme template directory.
     *
     * @since 1.5.0
     *
     * @param string $template_dir Absolute path to template directory.
     * @param string $template     Slug of the template.
     */
    $template_dir = apply_filters( 'template_directory', WP_CONTENT_DIR . '/themes/' . $template, $template );

    return $template_dir;
}

这段代码看着有点长，其实可以简化成这样：

缓存机制：第一次调用的时候，会计算出父主题的目录路径，然后存起来。以后再调用，就直接从缓存里取，省时省力。
获取模板名：通过 get_template() 函数获取当前使用的模板名称（也就是父主题的文件夹名）。
拼接路径：把 WP_CONTENT_DIR（WordPress内容目录，一般是 wp-content）、 /themes/ 和模板名拼接起来，得到完整的目录路径。
钩子过滤： apply_filters( 'template_directory', ...) 允许开发者通过钩子修改这个路径。这功能一般用不着，除非你想搞一些骚操作。

举个栗子：

假设你的WordPress安装在 /var/www/html/wordpress，你的父主题叫 twentytwentythree。那么，get_template_directory() 返回的值就是：

/var/www/html/wordpress/wp-content/themes/twentytwentythree

使用场景：

get_template_directory() 主要用于在PHP代码中引用父主题的文件。比如：

包含父主题的函数文件：

require_once get_template_directory() . '/inc/functions.php';

读取父主题的配置文件：

$config_file = get_template_directory() . '/config.json';
$config = json_decode( file_get_contents( $config_file ), true );

三、get_stylesheet_directory()：小弟，指向子主题或父主题

get_stylesheet_directory() 这个函数的作用是 获取当前样式表目录的路径。这玩意儿有点绕，因为在子主题的情况下，它指向的是子主题目录；如果没有使用子主题，它就指向父主题目录。

咱们再来看看它的源码：

function get_stylesheet_directory() {
    static $stylesheet_dir = null;

    if ( isset( $stylesheet_dir ) ) {
        return $stylesheet_dir;
    }

    $stylesheet = get_stylesheet();  // 获取当前样式表名称（子主题或父主题）

    /**
     * Filters the absolute path to the current theme stylesheet directory.
     *
     * @since 1.5.0
     *
     * @param string $stylesheet_dir Absolute path to stylesheet directory.
     * @param string $stylesheet     Slug of the stylesheet.
     */
    $stylesheet_dir = apply_filters( 'stylesheet_directory', WP_CONTENT_DIR . '/themes/' . $stylesheet, $stylesheet );

    return $stylesheet_dir;
}

这段代码和get_template_directory()几乎一样，唯一的区别在于：

获取样式表名：通过 get_stylesheet() 函数获取当前样式表名称。这个函数会判断当前是否使用了子主题，如果是，就返回子主题的文件夹名，否则返回父主题的文件夹名。

举个栗子：

假设你的WordPress安装在 /var/www/html/wordpress，你的父主题叫 twentytwentythree，你的子主题叫 twentytwentythree-child。

如果启用了 twentytwentythree 主题： get_stylesheet_directory() 返回的值是：

/var/www/html/wordpress/wp-content/themes/twentytwentythree
如果启用了 twentytwentythree-child 子主题： get_stylesheet_directory() 返回的值是：

/var/www/html/wordpress/wp-content/themes/twentytwentythree-child

使用场景：

get_stylesheet_directory() 主要用于在PHP代码中引用当前主题（子主题或父主题）的文件。比如：

包含当前主题的自定义CSS文件：
```
wp_enqueue_style( 'my-custom-style', get_stylesheet_directory_uri() . '/css/custom.css' );
```
注意这里用了 get_stylesheet_directory_uri()，它返回的是URL，而不是目录路径。

加载当前主题的JS文件：

wp_enqueue_script( 'my-custom-script', get_stylesheet_directory_uri() . '/js/custom.js', array( 'jquery' ), '1.0', true );

四、子主题应用：傻傻分不清？

好了，现在咱们来重点说说在子主题开发中，如何正确使用这两个函数。记住一个原则： 具体问题具体分析！

函数	作用	子主题环境下的指向	使用场景
`get_template_directory()`	获取父主题目录路径	始终指向父主题目录	引用父主题的特定文件（例如，需要强制加载父主题的某些函数或模板）
`get_stylesheet_directory()`	获取当前样式表目录路径（子主题或父主题）	指向子主题目录（如果启用了子主题）或父主题目录	引用当前主题（子主题或父主题）的文件（例如，加载当前主题的CSS、JS、图片等）。大多数情况下，子主题开发应该使用这个函数。

举个例子：

假设你的子主题需要重写父主题的 template-parts/content.php 文件。你应该怎么做？

复制文件：先把父主题的 template-parts/content.php 文件复制到你的子主题的 template-parts/content.php 目录。
修改文件：在子主题的 template-parts/content.php 文件中进行修改。
搞定！ WordPress会自动加载子主题的模板文件，覆盖父主题的同名文件。

但是，如果你的子主题需要引用父主题的某个特定的图片，比如 assets/images/logo.png，你应该使用 get_template_directory()：

<img src="<?php echo get_template_directory_uri(); ?>/assets/images/logo.png" alt="Logo">

因为你的子主题里没有 assets/images/logo.png 文件，所以必须明确指定引用父主题的文件。

五、避坑指南：前方高能预警！

URL vs 路径： get_template_directory() 和 get_stylesheet_directory() 返回的是 目录路径，不是URL。如果需要在HTML标签中使用，需要使用 get_template_directory_uri() 和 get_stylesheet_directory_uri()。
别瞎改源码：除非你有充分的理由，否则不要轻易修改这两个函数的返回值。改错了，你的主题就可能彻底瘫痪。
缓存问题： WordPress有缓存机制，有时候你修改了主题文件，但是页面上没有立即生效。可以尝试清除WordPress缓存或者浏览器缓存。
主题更新：如果你的父主题更新了，可能会影响你的子主题。所以，要定期检查你的子主题是否与新的父主题版本兼容。
路径拼接错误：拼接路径的时候要小心，不要漏掉斜杠 /，也不要多加斜杠。否则，你的文件可能找不到。

六、进阶技巧：使用常量定义主题路径

为了提高代码的可读性和可维护性，可以考虑使用常量来定义主题路径。比如，在你的子主题的 functions.php 文件中：

define( 'CHILD_THEME_DIR', get_stylesheet_directory() );
define( 'PARENT_THEME_DIR', get_template_directory() );
define( 'CHILD_THEME_URI', get_stylesheet_directory_uri() );
define( 'PARENT_THEME_URI', get_template_directory_uri() );

然后，在你的代码中就可以这样使用：

<img src="<?php echo PARENT_THEME_URI; ?>/assets/images/logo.png" alt="Logo">

这样看起来是不是更清晰了？

七、总结：掌握核心，灵活应用

get_template_directory() 和 get_stylesheet_directory() 这两个函数虽然简单，但却是WordPress主题开发的基础。理解它们的原理，掌握它们的使用场景，可以让你在子主题开发中游刃有余。

记住， 父主题用get_template_directory()，当前主题(子主题)用get_stylesheet_directory()。 另外，别忘了区分路径和URL。

希望今天的讲座对大家有所帮助。如果有什么疑问，欢迎在评论区留言。咱们下期再见！

发表回复 取消回复

发表回复取消回复