核心函数：`get_header()`和`get_footer()`背后的模板加载机制

大家好，今天我们来深入探讨一下 WordPress 主题开发中两个非常重要的函数：get_header() 和 get_footer()。这两个函数看似简单，但它们背后隐藏着一套复杂的模板加载机制，理解这些机制对于构建健壮、可维护的 WordPress 主题至关重要。

1. get_header() 和 get_footer() 的基本功能

首先，我们来回顾一下这两个函数的基本功能。

get_header( string $name = null, array $args = array() ): 加载头部模板文件。
get_footer( string $name = null, array $args = array() ): 加载底部模板文件。

简单来说，get_header() 会在主题目录中寻找 header.php 文件（或者根据 $name 参数指定的文件，例如 header-custom.php），并将其内容包含到当前页面中。get_footer() 则执行类似的操作，查找并包含 footer.php 文件（或 $name 指定的文件，例如 footer-sidebar.php）。

2. 模板加载的优先级和文件查找顺序

WordPress 的模板加载机制遵循一定的优先级顺序，确保了灵活性和可定制性。当调用 get_header() 或 get_footer() 时，WordPress 会按照以下顺序查找对应的模板文件：

优先级	文件名	说明
1	`header-{name}.php` 或 `footer-{name}.php`	如果 `$name` 参数被传递，WordPress 首先查找以此命名的文件。例如，如果调用 `get_header('custom')`，WordPress 会先查找 `header-custom.php`。
2	`header.php` 或 `footer.php`	如果没有找到带 `$name` 的文件，WordPress 会查找默认的 `header.php` 或 `footer.php` 文件。

3. 模板加载的内部机制：locate_template() 函数

get_header() 和 get_footer() 函数本身并不直接负责查找模板文件，它们实际上依赖于 WordPress 的核心函数 locate_template()。locate_template() 的作用是根据给定的模板文件名，在主题目录及其父主题目录中查找该文件，并返回文件的完整路径。

以下是 locate_template() 函数的简化版（省略了一些参数和过滤器）：

function locate_template( $template_names, $load = false, $require_once = true ) {
    $located = '';
    foreach ( (array) $template_names as $template_name ) {
        if ( ! $template_name ) {
            continue;
        }

        // 1. 检查子主题目录
        if ( file_exists( STYLESHEETPATH . '/' . $template_name ) ) {
            $located = STYLESHEETPATH . '/' . $template_name;
            break;
        }

        // 2. 检查父主题目录
        if ( file_exists( TEMPLATEPATH . '/' . $template_name ) ) {
            $located = TEMPLATEPATH . '/' . $template_name;
            break;
        }
    }

    if ( $load && '' !== $located ) {
        load_template( $located, $require_once );
    }

    return $located;
}

这个函数的流程如下：

遍历模板名称: 接收一个包含模板名称的数组，并逐个遍历。
检查子主题目录: 首先在子主题目录（STYLESHEETPATH）中查找模板文件。
检查父主题目录: 如果在子主题中没有找到，则在父主题目录（TEMPLATEPATH）中查找。
加载模板 (可选): 如果 $load 参数为 true，则使用 load_template() 函数加载找到的模板文件。
返回模板路径: 返回找到的模板文件的完整路径，如果没有找到，则返回空字符串。

4. load_template() 函数：加载模板

locate_template() 函数找到模板文件后，如果 $load 参数为 true，则会调用 load_template() 函数来加载模板文件。load_template() 函数实际上就是简单的 require_once() 或 require() 函数的封装，用于包含模板文件。

function load_template( $template_path, $require_once = true, $args = array() ) {
    global $posts, $post, $wp_did_header, $wp_did_template_redirect, $wp_query, $wp_rewrite, $wpdb, $wp_locale, $wp, $l10n;

    if ( is_array( $args ) ) {
        extract( $args, EXTR_SKIP );
    }

    if ( $require_once ) {
        require_once( $template_path );
    } else {
        require( $template_path );
    }
}

这个函数的主要作用是：

提取参数: 如果传递了 $args 参数，则使用 extract() 函数将其中的键值对提取为变量，以便在模板文件中使用。
包含模板文件: 使用 require_once() 或 require() 函数包含模板文件。require_once() 确保模板文件只被包含一次，而 require() 允许模板文件被包含多次。

5. get_header() 和 get_footer() 的源码分析

现在，让我们来看看 get_header() 和 get_footer() 函数的源码，以便更好地理解它们如何使用 locate_template() 和 load_template() 函数。

function get_header( $name = null, $args = array() ) {
    /**
     * Fires before the header template file is loaded.
     *
     * @since 2.1.0
     *
     * @param string|null $name Name of the specific header template to be loaded. Null for the default header.
     * @param array       $args Additional arguments passed to the header template.
     */
    do_action( 'get_header', $name, $args );

    $templates = array();
    $name = (string) $name;
    if ( '' !== $name ) {
        $templates[] = "header-{$name}.php";
    }

    $templates[] = 'header.php';

    /**
     * Filters the list of header template files to load.
     *
     * @since 2.1.0
     *
     * @param string[]    $templates The ordered list of header template files to load.
     *                              Includes header-{$name}.php and header.php.
     * @param string|null $name      Name of the specific header template to be loaded. Null for the default header.
     * @param array       $args      Additional arguments passed to the header template.
     */
    $templates = apply_filters( 'header_templates', $templates, $name, $args );

    locate_template( $templates, true, false, $args );
}

function get_footer( $name = null, $args = array() ) {
    /**
     * Fires before the footer template file is loaded.
     *
     * @since 2.1.0
     *
     * @param string|null $name Name of the specific footer template to be loaded. Null for the default footer.
     * @param array       $args Additional arguments passed to the footer template.
     */
    do_action( 'get_footer', $name, $args );

    $templates = array();
    $name = (string) $name;
    if ( '' !== $name ) {
        $templates[] = "footer-{$name}.php";
    }

    $templates[] = 'footer.php';

    /**
     * Filters the list of footer template files to load.
     *
     * @since 2.1.0
     *
     * @param string[]    $templates The ordered list of footer template files to load.
     *                              Includes footer-{$name}.php and footer.php.
     * @param string|null $name      Name of the specific footer template to be loaded. Null for the default footer.
     * @param array       $args      Additional arguments passed to the footer template.
     */
    $templates = apply_filters( 'footer_templates', $templates, $name, $args );

    locate_template( $templates, true, false, $args );
}

从源码中可以看出，get_header() 和 get_footer() 函数的流程大致相同：

触发 do_action(): 在加载模板文件之前，触发 get_header 或 get_footer action，允许插件或主题执行自定义操作。
构建模板名称数组: 根据 $name 参数构建一个包含模板名称的数组，例如 ['header-custom.php', 'header.php']。
应用过滤器: 应用 header_templates 或 footer_templates 过滤器，允许修改模板名称数组。这为插件和主题提供了更大的灵活性，可以根据需要添加或修改模板文件。
调用 locate_template(): 调用 locate_template() 函数，查找并加载模板文件。locate_template() 的第二个参数为 true，表示加载找到的模板文件。第三个参数为false，表示使用 require() 而不是 require_once()。第四个参数 $args 会传递到 load_template()，使得这些参数可以在模板文件中使用。

6. 实际应用示例

假设我们想要创建一个自定义的头部模板，用于显示特定的页面。我们可以这样做：

创建 header-special.php 文件: 在主题目录下创建一个名为 header-special.php 的文件，并编写自定义的头部内容。例如：
```
<header id="special-header">
    <h1>This is a special header!</h1>
</header>
```
在页面模板中使用 get_header('special'): 在需要使用自定义头部的页面模板中，调用 get_header('special') 函数。例如：
```
<?php get_header('special'); ?>

<main>
    
</main>

<?php get_footer(); ?>
```

这样，当访问使用该页面模板的页面时，就会加载 header-special.php 文件，并显示自定义的头部内容。

7. 使用 $args 参数传递数据

get_header() 和 get_footer() 函数都接受一个 $args 参数，允许将数据传递到模板文件中。这在需要在头部或底部显示动态内容时非常有用。

例如，我们想要在底部显示当前年份：

在 footer.php 文件中访问 $year 变量: 在 footer.php 文件中，我们可以像访问普通变量一样访问 $year 变量。
```
<footer>
    <p>&copy; <?php echo $year; ?> My Website</p>
</footer>
```
在页面模板中传递 $year 参数: 在调用 get_footer() 函数时，将 $year 参数传递进去。
```
<?php
$year = date('Y');
get_footer(null, array('year' => $year));
?>
```

这样，在底部就会显示当前的年份。

8. 子主题中的模板覆盖

WordPress 允许使用子主题来修改父主题的外观和功能。子主题可以覆盖父主题中的模板文件，而无需修改父主题本身。

当调用 get_header() 或 get_footer() 时，WordPress 会首先在子主题目录中查找对应的模板文件。如果找到，则使用子主题中的模板文件；否则，使用父主题中的模板文件。

例如，如果我们在子主题中创建了一个 header.php 文件，并修改了其中的内容，那么当调用 get_header() 函数时，就会加载子主题中的 header.php 文件，而不是父主题中的 header.php 文件。

9. 使用过滤器自定义模板加载

get_header() 和 get_footer() 函数都应用了 header_templates 和 footer_templates 过滤器，允许插件和主题自定义模板加载过程。

例如，我们可以使用 header_templates 过滤器来添加一个新的头部模板：

add_filter('header_templates', 'my_custom_header_template');

function my_custom_header_template($templates, $name, $args) {
    $templates[] = 'header-alternative.php';
    return $templates;
}

这个代码片段会将 header-alternative.php 添加到模板名称数组的末尾。这意味着，当调用 get_header() 函数时，WordPress 会首先查找 header-{name}.php 和 header.php，如果都没有找到，则会查找 header-alternative.php。

10. 调试模板加载

在开发 WordPress 主题时，有时可能会遇到模板加载问题，例如加载了错误的模板文件，或者模板文件没有被加载。为了解决这些问题，可以使用以下方法进行调试：

使用 locate_template() 函数进行测试: 可以直接调用 locate_template() 函数，并打印其返回值，以确定 WordPress 正在查找哪些模板文件，以及找到了哪个模板文件。
```
$templates = array('header-custom.php', 'header.php');
$located = locate_template($templates);
echo 'Located template: ' . $located;
```

使用 file_exists() 函数检查文件是否存在: 可以使用 file_exists() 函数来检查模板文件是否存在于主题目录中。

$template_path = STYLESHEETPATH . '/header-custom.php';
if (file_exists($template_path)) {
    echo 'Template file exists: ' . $template_path;
} else {
    echo 'Template file does not exist: ' . $template_path;
}

使用 var_dump() 函数打印变量: 可以使用 var_dump() 函数来打印 $templates 数组，以查看 WordPress 正在查找哪些模板文件。

add_filter('header_templates', 'debug_header_templates');

function debug_header_templates($templates) {
    var_dump($templates);
    return $templates;
}

模板加载机制的核心要点

理解 get_header() 和 get_footer() 背后的模板加载机制，对于构建灵活、可定制的 WordPress 主题至关重要。掌握文件查找顺序、locate_template() 函数、load_template() 函数、子主题中的模板覆盖以及使用过滤器自定义模板加载等关键概念，能更好地理解和控制 WordPress 的模板加载过程。

核心函数：get_header()和get_footer()背后的模板加载机制

发表回复 取消回复

核心函数：`get_header()`和`get_footer()`背后的模板加载机制

发表回复取消回复