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

各位观众老爷们，大家好！我是你们的老朋友，代码界的段子手，今天咱们来聊聊WordPress里一对相爱相杀的好基友——get_stylesheet_directory() 和 get_template_directory()。别看名字长，其实用起来特简单，但是背后的原理，尤其是在子主题里，可是藏了不少小秘密呢。今天咱们就扒开它们的外衣，看看它们到底在干啥。

一、开场白：主题与子主题，不得不说的故事

在开始深入源码之前，咱们先简单回顾一下主题和子主题的概念。

主题 (Theme)： 相当于网站的皮肤，决定了网站的整体外观和功能。
子主题 (Child Theme)： 寄生在主题上的一个小弟，可以修改主题的部分内容，而不用直接修改主题本身。这样做的好处是，当主题更新时，你的修改不会被覆盖。

想象一下，主题是毛坯房，子主题就是你的装修。你可以在毛坯房里加点自己喜欢的设计，但是毛坯房本身还是毛坯房，没啥变化。

二、get_stylesheet_directory()：我的地盘我做主

get_stylesheet_directory() 函数的作用是返回当前样式表目录的绝对路径。记住，是样式表目录，不是模板目录。

如果当前使用的是父主题： 返回的就是父主题的目录。
如果当前使用的是子主题： 返回的就是子主题的目录。

简单来说，get_stylesheet_directory() 永远指向你当前正在使用的那个主题（不管是父主题还是子主题）的样式表目录。

咱们来看一下它的源码（简化版，去掉了不重要的部分）：

function get_stylesheet_directory() {
    /**
     * Filters the stylesheet directory path.
     *
     * @since 1.5.0
     *
     * @param string $stylesheet_dir The absolute path to the stylesheet directory.
     * @param string $stylesheet      The stylesheet name.
     */
    return apply_filters( 'stylesheet_directory', get_template_directory_uri(), get_stylesheet() );
}

看起来是不是很简单？它主要就是调用了 get_template_directory_uri() (这个函数咱们稍后会讲)，然后用 apply_filters() 加上了一个过滤器 ‘stylesheet_directory’ 。这个过滤器允许你修改返回的路径，不过一般情况下我们不会用到。

三、get_template_directory()：老爹的地盘我来罩着

get_template_directory() 函数的作用是返回模板目录的绝对路径。

如果当前使用的是父主题： 返回的就是父主题的目录。
如果当前使用的是子主题： 返回的仍然是父主题的目录！

重点来了！即使你在使用子主题，get_template_directory() 仍然指向的是父主题的目录。这是它和 get_stylesheet_directory() 最大的区别。

它的源码也比较简单：

function get_template_directory() {
    /**
     * Filters the template directory path.
     *
     * @since 1.5.0
     *
     * @param string $template_dir The absolute path to the template directory.
     * @param string $template     The template name.
     */
    return apply_filters( 'template_directory', WP_CONTENT_DIR . '/' . get_template() );
}

同样，这里也使用了 apply_filters() 来允许修改返回的路径。

四、源码分析：拨开云雾见真相

现在咱们来更深入地分析一下这两个函数的工作原理。

get_stylesheet() 函数： 这个函数返回的是当前正在使用的样式表的名字，也就是主题的文件夹名。如果是子主题，返回的就是子主题的文件夹名。
get_template() 函数： 这个函数返回的是父主题的名字。即使在使用子主题，它返回的仍然是父主题的文件夹名。
WP_CONTENT_DIR 常量： 这个常量定义了 WordPress 内容目录的绝对路径，通常是 wp-content 文件夹。

所以，get_template_directory() 的本质就是把 WP_CONTENT_DIR 常量和 get_template() 函数的返回值拼接起来，得到父主题的目录。

五、实战演练：子主题中的应用

现在咱们来看看在子主题中如何使用这两个函数。假设我们有一个父主题，名为 "ParentTheme"，子主题名为 "ChildTheme"。

引入样式文件：

假设我们想在子主题中引入一个父主题的样式文件 style-parent.css，我们可以这样做：

function my_theme_enqueue_styles() {
    $parent_style = 'parent-style'; // This is 'twentyfifteen-style' for the Twenty Fifteen theme.

    wp_enqueue_style( $parent_style,
        get_template_directory_uri() . '/style.css'
    );
    wp_enqueue_style( 'child-style',
        get_stylesheet_directory_uri() . '/style.css',
        array( $parent_style ),
        wp_get_theme()->get('Version')
    );
}
add_action( 'wp_enqueue_scripts', 'my_theme_enqueue_styles' );

get_template_directory_uri()：获取父主题的URI（网络路径），然后拼上 /style.css，得到父主题样式表的完整URL。
get_stylesheet_directory_uri()：获取子主题的URI（网络路径），然后拼上 /style.css，得到子主题样式表的完整URL。

覆盖模板文件：

假设我们想在子主题中覆盖父主题的 single.php 文件，只需要在子主题中创建一个同名文件 single.php 即可。 WordPress 会自动优先加载子主题中的模板文件。

如果在子主题的 single.php 文件中需要调用父主题的 single.php 文件，可以使用以下代码：
```
get_template_part( 'template-parts/content', 'single' );
```
或者，如果你想更精确地调用父主题的 single.php，可以使用：
```
include( get_template_directory() . '/single.php' );
```
这里 get_template_directory() 返回的是父主题的目录，所以可以正确地找到父主题的 single.php 文件。
加载自定义函数：

假设我们想在子主题中加载一个自定义函数文件 functions-child.php，可以这样做：
```
require_once( get_stylesheet_directory() . '/functions-child.php' );
```
这里 get_stylesheet_directory() 返回的是子主题的目录，所以可以正确地找到子主题的 functions-child.php 文件。

六、get_stylesheet_directory_uri() 和 get_template_directory_uri()：网络路径的亲兄弟

刚才我们提到了 get_stylesheet_directory_uri() 和 get_template_directory_uri() 这两个函数，它们和 get_stylesheet_directory() 和 get_template_directory() 类似，只不过返回的是 URL (URI) 而不是文件路径。

get_stylesheet_directory_uri()：返回当前样式表目录的URL。
get_template_directory_uri()：返回模板目录的URL。

它们的源码也比较简单，就是在 get_stylesheet_directory() 和 get_template_directory() 的基础上，使用 wp_make_link_relative() 函数将绝对路径转换为相对URL。

七、避坑指南：使用中的注意事项

文件路径 vs. URL： 记住 get_stylesheet_directory() 和 get_template_directory() 返回的是文件路径，而 get_stylesheet_directory_uri() 和 get_template_directory_uri() 返回的是 URL。不要混淆使用。
子主题中的模板覆盖： 当子主题和父主题都有同名的模板文件时，WordPress 会优先加载子主题中的模板文件。
正确引用资源文件： 在子主题中引用父主题的资源文件时，一定要使用 get_template_directory_uri() 函数。
避免硬编码路径： 尽量使用 WordPress 提供的函数来获取目录路径和 URL，避免硬编码路径，这样可以提高代码的灵活性和可移植性。
理解函数的作用域： 不同的函数有不同的作用域，get_stylesheet_directory() 永远指向当前正在使用的那个主题，而 get_template_directory() 永远指向父主题。

八、进阶技巧：自定义过滤器

前面我们提到 get_stylesheet_directory() 和 get_template_directory() 函数都使用了 apply_filters() 过滤器，这意味着我们可以通过自定义过滤器来修改它们的返回值。

例如，我们可以创建一个过滤器来将 get_template_directory() 函数的返回值指向子主题目录：

add_filter( 'template_directory', 'my_custom_template_directory' );
function my_custom_template_directory( $template_dir ) {
    return get_stylesheet_directory();
}

但是，强烈不建议这样做！ 这会改变 get_template_directory() 函数的默认行为，可能会导致一些插件或主题出现问题。除非你有非常特殊的需要，否则不要轻易修改这些函数的返回值。

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

get_stylesheet_directory() 和 get_template_directory() 是 WordPress 主题开发中非常重要的两个函数。它们可以帮助我们轻松地获取主题目录的路径，从而方便地引用资源文件、覆盖模板文件和加载自定义函数。在子主题开发中，理解这两个函数的区别和作用至关重要。

函数	返回值	子主题中的行为
`get_stylesheet_directory()`	当前样式表目录的绝对路径	返回子主题的目录
`get_template_directory()`	模板目录（父主题）的绝对路径	返回父主题的目录
`get_stylesheet_directory_uri()`	当前样式表目录的URL	返回子主题的URL
`get_template_directory_uri()`	模板目录（父主题）的URL	返回父主题的URL

希望今天的讲解能够帮助大家更好地理解这两个函数，并在实际开发中灵活应用。记住，理解原理比死记硬背更重要！

好啦，今天的讲座就到这里，希望大家喜欢！咱们下次再见！

发表回复 取消回复

发表回复取消回复