解释 `is_singular()` 和 `is_archive()` 等条件标签的源码，它们如何基于 `WP_Query` 对象的属性来判断当前页面类型？

各位好，欢迎来到今天的“WordPress 条件标签源码深度剖析”讲座！我是你们今天的向导，准备好一起扒开这些看似神秘的 is_singular()、is_archive() 函数的底裤，看看它们到底是怎么工作的了吗？

今天咱们的目标是：

搞清楚条件标签是什么，为什么我们需要它们。
深入源码，理解 is_singular() 和 is_archive() 背后的逻辑。
了解这些标签是如何利用 WP_Query 对象的属性来判断页面类型的。
掌握如何自定义条件标签，让你的主题更灵活。

准备好了吗？Let’s dive in!

什么是条件标签？

想象一下，你正在设计一个 WordPress 主题，你想在文章页显示不同的广告，在分类页显示不同的侧边栏，在首页显示不同的横幅。怎么办？难道要在每个模板文件里都写一大堆 if...else 语句？那代码就太冗余了，而且难以维护。

条件标签就是来解决这个问题的。它们就像主题里的“侦察兵”，专门负责判断当前页面是什么类型的，然后根据判断结果，我们可以执行不同的代码。

例如，is_single() 用于判断当前页面是否为文章页，is_category() 用于判断当前页面是否为分类页。它们返回 true 或 false，我们可以用它们来控制模板的输出。

WP_Query：条件标签的幕后英雄

要理解条件标签的工作原理，首先要了解 WP_Query 这个类。它是 WordPress 查询数据库的核心类，负责获取文章、页面、分类等数据。

当我们访问一个 WordPress 页面时，WordPress 会自动创建一个 WP_Query 对象（通常被称为 $wp_query，全局变量），并根据 URL 参数来设置这个对象的属性。例如，如果 URL 是 example.com/category/news/，$wp_query 对象就会被设置为显示 news 分类下的文章。

条件标签正是利用 $wp_query 对象的属性来判断页面类型的。

is_singular()：深入源码

is_singular() 函数用于判断当前页面是否为单个文章、页面或自定义文章类型。我们来看看它的源码：

function is_singular( $post_types = '' ) {
    global $wp_query;

    if ( ! isset( $wp_query ) ) {
        return false;
    }

    if ( ! $wp_query->is_singular ) {
        return false;
    }

    if ( empty( $post_types ) ) {
        return true;
    }

    $post_types = (array) $post_types;

    $current_post_type = get_post_type( $wp_query->get_queried_object_id() );

    return in_array( $current_post_type, $post_types, true );
}

逐步解析：

global $wp_query;: 首先，它声明 $wp_query 为全局变量，这样才能访问到它。
if ( ! isset( $wp_query ) ) { return false; }: 检查 $wp_query 对象是否存在。如果不存在，说明 WordPress 可能还没有初始化，直接返回 false。
if ( ! $wp_query->is_singular ) { return false; }: 这是关键的一步！它检查 $wp_query 对象的 is_singular 属性是否为 true。如果不是，说明当前页面不是单个文章、页面或自定义文章类型，直接返回 false。
if ( empty( $post_types ) ) { return true; }: 如果 $post_types 参数为空，说明我们没有指定要判断的文章类型，那么只要 $wp_query->is_singular 为 true，就返回 true。
$post_types = (array) $post_types;: 将 $post_types 参数转换为数组，方便后续处理。
$current_post_type = get_post_type( $wp_query->get_queried_object_id() );: 获取当前页面的文章类型。$wp_query->get_queried_object_id() 获取的是当前查询对象的 ID，然后 get_post_type() 函数根据 ID 获取文章类型。
return in_array( $current_post_type, $post_types, true );: 判断当前文章类型是否在 $post_types 数组中。如果在，返回 true，否则返回 false。

重点：$wp_query->is_singular 属性

is_singular() 函数的核心在于检查 $wp_query->is_singular 属性。这个属性是由 WordPress 在解析 URL 时设置的。如果 URL 对应的是单个文章、页面或自定义文章类型，$wp_query->is_singular 就会被设置为 true，否则为 false。

is_archive()：源码剖析

is_archive() 函数用于判断当前页面是否为归档页，例如分类页、标签页、作者页、日期页等。我们来看看它的源码：

function is_archive( $post_types = '' ) {
    global $wp_query;

    if ( ! isset( $wp_query ) ) {
        return false;
    }

    if ( ! $wp_query->is_archive ) {
        return false;
    }

    if ( empty( $post_types ) ) {
        return true;
    }

    $post_types = (array) $post_types;

    if ( $wp_query->is_post_type_archive ) {
        if ( in_array( $wp_query->query_vars['post_type'], $post_types, true ) ) {
            return true;
        } else {
            return false;
        }
    }

    if ( $wp_query->is_category || $wp_query->is_tag || $wp_query->is_tax ) {
        if ( ! empty( $post_types ) ) {
            return false;
        } else {
            return true;
        }
    }

    return false;
}

逐步解析：

global $wp_query;: 同样，声明 $wp_query 为全局变量。
if ( ! isset( $wp_query ) ) { return false; }: 检查 $wp_query 对象是否存在。
if ( ! $wp_query->is_archive ) { return false; }: 这是关键的一步！检查 $wp_query 对象的 is_archive 属性是否为 true。
if ( empty( $post_types ) ) { return true; }: 如果 $post_types 参数为空，说明我们没有指定要判断的文章类型，那么只要 $wp_query->is_archive 为 true，就返回 true。
$post_types = (array) $post_types;: 将 $post_types 参数转换为数组。
if ( $wp_query->is_post_type_archive ) { ... }: 如果 $wp_query->is_post_type_archive 为 true，说明当前页面是文章类型归档页（例如自定义文章类型的归档页）。
- if ( in_array( $wp_query->query_vars['post_type'], $post_types, true ) ) { return true; }: 判断当前文章类型是否在 $post_types 数组中。
if ( $wp_query->is_category || $wp_query->is_tag || $wp_query->is_tax ) { ... }: 如果 $wp_query->is_category、$wp_query->is_tag 或 $wp_query->is_tax 为 true，说明当前页面是分类页、标签页或自定义分类法页。
- if ( ! empty( $post_types ) ) { return false; } else { return true; }: 如果 $post_types 参数不为空，返回 false（因为这些归档页不是文章类型归档页）；否则，返回 true。

重点：$wp_query->is_archive 和其他属性

is_archive() 函数的核心在于检查 $wp_query->is_archive 属性以及其他相关属性，例如 $wp_query->is_category、$wp_query->is_tag、$wp_query->is_tax 和 $wp_query->is_post_type_archive。这些属性也是由 WordPress 在解析 URL 时设置的。

WP_Query 对象的关键属性

为了更好地理解条件标签的工作原理，我们来看看 WP_Query 对象中一些重要的属性：

属性	描述
`is_single`	如果查询是针对单个文章的，则为 `true`。
`is_page`	如果查询是针对单个页面的，则为 `true`。
`is_singular`	如果查询是针对单个文章、页面或自定义文章类型的，则为 `true`（`is_single` 或 `is_page` 或 `is_post_type_archive` 为 `true`）。
`is_archive`	如果查询是针对归档页面的，则为 `true`（例如分类页、标签页、作者页、日期页）。
`is_category`	如果查询是针对分类页面的，则为 `true`。
`is_tag`	如果查询是针对标签页面的，则为 `true`。
`is_tax`	如果查询是针对自定义分类法页面的，则为 `true`。
`is_post_type_archive`	如果查询是针对文章类型归档页面的，则为 `true`（例如自定义文章类型的归档页）。
`is_home`	如果查询是针对主页的，则为 `true`（通常是显示最新文章的页面）。
`is_front_page`	如果查询是针对静态首页的，则为 `true`（需要在 WordPress 设置中指定）。
`is_search`	如果查询是针对搜索结果页面的，则为 `true`。
`is_404`	如果查询没有找到任何匹配的页面，则为 `true`。

如何自定义条件标签？

有时候，内置的条件标签可能无法满足我们的需求。例如，我们可能需要判断当前页面是否为某个特定的自定义文章类型的归档页，或者判断当前页面是否使用了某个特定的模板。

这时，我们可以自定义条件标签。自定义条件标签的本质是创建一个函数，该函数根据 $wp_query 对象的属性或其他条件来判断页面类型，并返回 true 或 false。

例如，我们可以创建一个自定义条件标签 is_book_archive()，用于判断当前页面是否为 book 自定义文章类型的归档页：

function is_book_archive() {
    global $wp_query;

    if ( ! isset( $wp_query ) ) {
        return false;
    }

    return ( $wp_query->is_post_type_archive && $wp_query->query_vars['post_type'] == 'book' );
}

这个函数首先检查 $wp_query 对象是否存在，然后判断 $wp_query->is_post_type_archive 是否为 true，并且 $wp_query->query_vars['post_type'] 是否为 book。如果两个条件都满足，就返回 true，否则返回 false。

使用自定义条件标签

定义好自定义条件标签后，我们就可以在主题模板中使用它了：

<?php if ( is_book_archive() ) : ?>
    <div class="book-archive-banner">
        <h1>欢迎来到图书归档页！</h1>
    </div>
<?php else : ?>
    <div class="default-banner">
        <h1>欢迎来到其他页面！</h1>
    </div>
<?php endif; ?>

总结

今天我们深入探讨了 WordPress 条件标签的源码，了解了它们是如何利用 WP_Query 对象的属性来判断页面类型的。我们还学习了如何自定义条件标签，让主题更加灵活。

希望今天的讲座能帮助你更好地理解 WordPress 的内部机制，并能更加自信地开发 WordPress 主题。

记住，理解源码是成为 WordPress 大师的关键一步。继续探索，你会发现更多惊喜！

下次再见！

发表回复 取消回复

发表回复取消回复