发布于 由admin

分析 WordPress `get_post_type_archive_link()` 函数的源码：如何生成归档链接并避免不必要的数据库查询。

各位观众老爷们，晚上好！我是你们的老朋友，一位平平无奇的 WordPress 代码搬运工。今天咱们不聊风花雪月，来点硬核的，一起扒一扒 WordPress 里的 get_post_type_archive_link() 函数的底裤，看看它是怎么生成归档链接的，又是怎么耍小聪明避免不必要的数据库查询的。

开场白：为啥要研究这个函数？

话说 WordPress 作为一个强大的 CMS，内容类型那是相当丰富，文章、页面、自定义文章类型，应有尽有。而这些内容类型往往都需要一个归档页面，用来展示该类型下的所有文章列表。get_post_type_archive_link() 这个函数，就是用来生成这些归档页面的链接的。

掌握了这个函数的原理，你就能更灵活地控制你的 WordPress 站点 URL，还能避免一些性能问题，甚至能写出更优雅的代码。是不是很诱人？ 那咱们就废话不多说，直接开搞！

第一幕：get_post_type_archive_link() 的基本用法

首先，咱们来看一下 get_post_type_archive_link() 的基本用法。这玩意儿的使用方法很简单，就一个参数，就是你要生成归档链接的文章类型名称。

<?php
$post_type = 'book'; // 假设我们有一个名为 'book' 的自定义文章类型
$archive_link = get_post_type_archive_link( $post_type );

if ( $archive_link ) {
    echo '<a href="' . esc_url( $archive_link ) . '">浏览所有书籍</a>';
} else {
    echo '该文章类型没有归档页面';
}
?>

这段代码的意思是，如果存在 book 这种文章类型的归档页面，就生成一个链接，链接文本是“浏览所有书籍”。如果不存在，就显示“该文章类型没有归档页面”。

是不是很简单？ 但是，你知道 WordPress 内部是怎么找到这个归档页面的吗？ 这就是咱们接下来要深究的地方。

第二幕：深入源码，一探究竟

想要彻底了解 get_post_type_archive_link()，光会用可不行，还得深入源码。咱们打开 wp-includes/link-template.php 文件，找到 get_post_type_archive_link() 函数的定义。

这个函数的核心代码大概是这样的：

function get_post_type_archive_link( $post_type = 'post', $echo = false ) {
    global $wp_rewrite;

    $post_type_object = get_post_type_object( $post_type );

    if ( ! $post_type_object ) {
        return false;
    }

    if ( ! $post_type_object->has_archive ) {
        return false;
    }

    $has_archive = $post_type_object->has_archive;

    $link = '';

    if ( is_string( $has_archive ) ) {
        $link = home_url( trailingslashit( $has_archive ) );
    } elseif ( true === $has_archive ) {
        if ( $wp_rewrite->using_permalinks() ) {
            $link = home_url( $post_type_object->rewrite['slug'] );
            if ( $post_type_object->rewrite['with_front'] ) {
                $link = home_url( trailingslashit( $wp_rewrite->front ) . $post_type_object->rewrite['slug'] );
            }
            $link = trailingslashit( $link );
        } else {
            $link = add_query_arg( 'post_type', $post_type, home_url() );
        }
    } else {
        return false;
    }

    /**
     * Filters the post type archive link.
     *
     * @since 2.5.0
     *
     * @param string $link      Post type archive link.
     * @param string $post_type Post type name.
     */
    $link = apply_filters( 'post_type_archive_link', $link, $post_type );

    if ( $echo ) {
        echo esc_url( $link );
    } else {
        return esc_url( $link );
    }
}

代码有点长，咱们一点一点分析。

第三幕：代码解读，抽丝剥茧

  1. 获取文章类型对象 (get_post_type_object):

    首先，函数会调用 get_post_type_object( $post_type ) 来获取文章类型对象。这个函数会从全局变量 $wp_post_types 中查找对应的文章类型对象。如果找不到，就返回 false。

    $post_type_object = get_post_type_object( $post_type );

if ( ! $post_type_object ) {
    return false;
}

    这里就是避免不必要的数据库查询的第一步。get_post_type_object() 优先从已经加载到内存中的文章类型对象中查找，而不是直接去数据库查询。如果文章类型对象已经被注册，那么这个查找过程会非常快。

  2. 检查是否启用归档 ($post_type_object->has_archive):

    接下来，函数会检查文章类型对象中的 has_archive 属性。这个属性决定了该文章类型是否启用了归档页面。

    if ( ! $post_type_object->has_archive ) {
    return false;
}

$has_archive = $post_type_object->has_archive;

    has_archive 属性的值可以是以下几种情况：

    • false：表示该文章类型没有启用归档页面。
    • true：表示启用归档页面，并且使用默认的 URL 结构。
    • string：表示启用归档页面，并且使用指定的 URL 别名。

  3. 生成归档链接:

    接下来，函数会根据 has_archive 属性的值来生成归档链接。

    • 如果 has_archive 是一个字符串:

      if ( is_string( $has_archive ) ) {
    $link = home_url( trailingslashit( $has_archive ) );
}

      表示使用了自定义的归档 URL 别名。例如，如果你的 book 文章类型的 has_archive 属性设置为 'books'，那么归档链接就是 http://your-domain.com/books/。

      home_url() 函数返回站点的首页 URL，trailingslashit() 函数会在 URL 后面添加一个斜杠。

    • 如果 has_archive 是 true:

      elseif ( true === $has_archive ) {
    if ( $wp_rewrite->using_permalinks() ) {
        $link = home_url( $post_type_object->rewrite['slug'] );
        if ( $post_type_object->rewrite['with_front'] ) {
            $link = home_url( trailingslashit( $wp_rewrite->front ) . $post_type_object->rewrite['slug'] );
        }
        $link = trailingslashit( $link );
    } else {
        $link = add_query_arg( 'post_type', $post_type, home_url() );
    }
}

      表示使用默认的 URL 结构。 这里又分两种情况：

      • 如果启用了固定链接 ($wp_rewrite->using_permalinks() 为 true):

        函数会根据文章类型对象的 rewrite 属性来生成 URL。rewrite['slug'] 属性表示 URL 别名，rewrite['with_front'] 属性表示是否在 URL 中包含 front 字符串（通常是你的分类目录基础）。

        例如，如果你的 book 文章类型的 rewrite['slug'] 属性设置为 'book'，并且 rewrite['with_front'] 属性设置为 true，那么归档链接就是 http://your-domain.com/category-base/book/。

      • 如果没有启用固定链接 ($wp_rewrite->using_permalinks() 为 false):

        函数会使用查询字符串来生成 URL。例如，归档链接就是 http://your-domain.com/?post_type=book。

        add_query_arg() 函数用于向 URL 中添加查询字符串参数。

    • 如果 has_archive 是其他值:

      函数会返回 false，表示无法生成归档链接。

  4. 应用过滤器 (apply_filters):

    $link = apply_filters( 'post_type_archive_link', $link, $post_type );

    函数会应用 post_type_archive_link 过滤器，允许开发者自定义归档链接。你可以使用这个过滤器来修改 URL，或者添加一些额外的参数。

  5. 返回链接:

    if ( $echo ) {
    echo esc_url( $link );
} else {
    return esc_url( $link );
}

    最后，函数会根据 $echo 参数的值来决定是直接输出链接，还是返回链接。esc_url() 函数用于对 URL 进行转义，防止 XSS 攻击。

第四幕：避免不必要的数据库查询的秘密

咱们再来深入聊聊 get_post_type_archive_link() 是如何避免不必要的数据库查询的。

  1. get_post_type_object() 的缓存机制:

    前面提到了，get_post_type_object() 函数会优先从全局变量 $wp_post_types 中查找文章类型对象。这个全局变量存储了所有已经注册的文章类型对象。

    当 WordPress 启动时，或者当插件或主题注册新的文章类型时，文章类型对象会被添加到 $wp_post_types 中。因此，如果你的文章类型已经被注册，那么 get_post_type_object() 函数就不需要去数据库查询，而是直接从内存中获取。

    这大大提高了性能，特别是当你的站点有很多自定义文章类型时。

  2. wp_rewrite 对象的缓存机制:

    在生成固定链接时，函数会使用 $wp_rewrite 对象来获取 URL 结构信息。$wp_rewrite 对象包含了 WordPress 的固定链接规则。

    $wp_rewrite 对象也是一个全局对象，它会在 WordPress 初始化时被创建，并且会被缓存起来。因此，每次调用 $wp_rewrite->using_permalinks() 和 $wp_rewrite->front 时，都不需要去数据库查询，而是直接从内存中获取。

  3. has_archive 的值:

    通过设置 has_archive 的值，可以避免一些不必要的 URL 生成逻辑。如果 has_archive 设置为 false，函数会直接返回 false，而不会执行任何 URL 生成代码。如果 has_archive 设置为一个字符串，函数会直接使用该字符串作为 URL 别名，而不需要进行复杂的 URL 构造。

第五幕：实战演练，代码优化

了解了 get_post_type_archive_link() 的原理，咱们就可以利用这些知识来优化代码，提高性能。

  1. 确保文章类型已经注册:

    在使用 get_post_type_archive_link() 之前，务必确保你的文章类型已经注册。否则，get_post_type_object() 函数会返回 false，导致函数无法生成归档链接。

    你可以在 functions.php 文件中，或者在你的插件中注册文章类型。例如：

    add_action( 'init', 'register_book_post_type' );
function register_book_post_type() {
    $args = array(
        'labels' => array(
            'name' => '书籍',
            'singular_name' => '书籍',
        ),
        'public' => true,
        'has_archive' => true, // 启用归档页面
        'rewrite' => array( 'slug' => 'book' ), // 设置 URL 别名
    );
    register_post_type( 'book', $args );
}

  2. 合理设置 has_archive 属性:

    根据你的需求，合理设置 has_archive 属性的值。

    • 如果你的文章类型不需要归档页面，就将 has_archive 设置为 false。
    • 如果你的文章类型需要归档页面，并且可以使用默认的 URL 结构，就将 has_archive 设置为 true。
    • 如果你的文章类型需要归档页面，并且需要使用自定义的 URL 别名，就将 has_archive 设置为一个字符串。

  3. 使用缓存:

    如果你需要在多个地方使用 get_post_type_archive_link() 函数，可以将结果缓存起来，避免重复调用。

    例如：

    $post_type = 'book';
$cache_key = 'book_archive_link';
$archive_link = wp_cache_get( $cache_key );

if ( false === $archive_link ) {
    $archive_link = get_post_type_archive_link( $post_type );
    wp_cache_set( $cache_key, $archive_link );
}

if ( $archive_link ) {
    echo '<a href="' . esc_url( $archive_link ) . '">浏览所有书籍</a>';
} else {
    echo '该文章类型没有归档页面';
}

    这段代码使用了 WordPress 的对象缓存 API (wp_cache_get() 和 wp_cache_set()) 来缓存归档链接。

第六幕：表格总结

为了方便大家理解，咱们用一个表格来总结一下 get_post_type_archive_link() 函数的关键点：

特性 说明 作用
get_post_type_object() 从全局变量 $wp_post_types 中获取文章类型对象，如果找不到，返回 false。 避免不必要的数据库查询，提高性能。
$has_archive 决定是否启用归档页面，以及使用哪种 URL 结构。可以是 false、true 或一个字符串。 控制归档页面的行为，避免不必要的 URL 生成逻辑。
$wp_rewrite 包含 WordPress 的固定链接规则，用于生成固定链接。 避免每次都去数据库查询固定链接规则，提高性能。
apply_filters 允许开发者自定义归档链接。 提供灵活性，允许开发者根据自己的需求修改 URL。
对象缓存 使用 WordPress 的对象缓存 API (wp_cache_get() 和 wp_cache_set()) 来缓存归档链接，避免重复调用 get_post_type_archive_link()。 进一步提高性能，特别是当需要在多个地方使用归档链接时。

尾声：举一反三，触类旁通

好了，今天的讲座就到这里。希望通过这次深入的源码分析，你能够更好地理解 get_post_type_archive_link() 函数的原理，并且能够灵活运用这些知识来优化你的 WordPress 站点。

记住，学习编程就像练武功，光看秘籍是不行的，还要勤加练习，举一反三，触类旁通。只有这样，你才能真正掌握代码的力量，成为一名真正的 WordPress 大侠！

感谢各位的收看，咱们下期再见！

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注