分析 wp_get_archives 如何生成归档链接结构 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

WordPress 归档链接结构生成机制深度剖析：`wp_get_archives` 函数详解

各位同学，今天我们来深入探讨 WordPress 中一个非常重要且常用的函数：wp_get_archives。这个函数负责生成各种形式的归档链接，是构建网站导航、侧边栏归档列表等功能的核心。理解其工作原理，能帮助我们更好地定制和优化 WordPress 网站。

1. wp_get_archives 函数的基本用法和参数

wp_get_archives 函数的基本语法如下：

<?php wp_get_archives( $args ); ?>

其中 $args 是一个数组，用于传递各种参数来控制归档链接的生成方式。让我们先看看一些常用的参数：

参数名称	类型	默认值	描述
`type`	string	‘monthly’	指定归档的类型。可选值：’yearly’, ‘monthly’, ‘daily’, ‘weekly’, ‘postbypost’, ‘alpha’。
`limit`	int	”	限制显示的归档数量。
`format`	string	‘html’	指定输出格式。可选值：’html’, ‘option’, ‘link’, ‘custom’。 ‘html’ 输出 HTML 列表，’option’ 输出 HTML 下拉列表选项， ‘link’ 输出链接地址， ‘custom’ 需要配合 `before` 和 `after` 参数使用。
`before`	string	”	在每个归档链接前添加的内容。仅当 `format` 为 ‘custom’ 时有效。
`after`	string	”	在每个归档链接后添加的内容。仅当 `format` 为 ‘custom’ 时有效。
`show_post_count`	bool	false	是否显示每个归档中的文章数量。
`echo`	bool	true	是否直接输出结果。如果设置为 false，则返回字符串。
`order`	string	‘DESC’	归档的排序方式。可选值：’ASC’, ‘DESC’。
`orderby`	string	‘name’	归档的排序依据。可选值：’name’, ‘post_date’, ‘post_count’。不同的 `type` 有不同的默认值。`monthly`, `yearly` 和 `daily` 的默认值是 ‘name’ (年月顺序)， `postbypost` 的默认值是 ‘post_date’ (文章发布日期)， `alpha` 默认值是 ‘name’ (字母顺序)。
`post_type`	string	‘post’	指定要查询的文章类型。
`date_format`	string	（根据 `type` 而定）	指定日期格式。只有当 `type` 为 ‘monthly’, ‘yearly’, ‘daily’ 时有效。

一个简单的例子：

<?php
$args = array(
    'type'            => 'monthly',
    'limit'           => 12,
    'format'          => 'html',
    'show_post_count' => true,
    'order'           => 'DESC'
);
wp_get_archives( $args );
?>

这段代码会生成一个按月归档的 HTML 列表，最多显示 12 个月，并显示每个月发布的文章数量，按降序排列。

2. wp_get_archives 函数的内部实现

wp_get_archives 函数的实现位于 wp-includes/general-template.php 文件中。它的核心逻辑可以概括为以下几个步骤：

参数解析与处理: 函数首先会合并传入的参数 $args 和默认参数，并进行一些必要的类型转换和验证。例如，将 show_post_count 参数转换为布尔值。
SQL 查询构建: 根据 type 参数的不同，函数会构建不同的 SQL 查询语句来获取归档数据。这是整个函数的核心部分，也是最复杂的部分。
数据获取: 使用 $wpdb 对象执行 SQL 查询，获取归档数据。
数据格式化: 根据 format 参数的不同，函数会将获取到的归档数据格式化为不同的输出格式，例如 HTML 列表、下拉列表选项或链接地址。
结果输出: 根据 echo 参数的不同，函数会将格式化后的结果直接输出到浏览器，或者返回一个字符串。

下面我们详细分析不同 type 参数下的 SQL 查询构建过程。

2.1 type 为 monthly 的情况

这是最常用的归档类型。函数会查询数据库中所有文章的发布日期，并按月进行分组。

构建 SQL 查询的核心代码如下 (简化版)：

global $wpdb, $wp_locale;

$now = current_time('mysql', 1);
$lastpost = $wpdb->get_var("SELECT post_date FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = '$post_type' ORDER BY post_date DESC LIMIT 1");

// Prepare date limits
$year_last  = substr($lastpost, 0, 4);
$month_last = substr($lastpost, 5, 2);
$year_now   = substr($now, 0, 4);
$month_now  = substr($now, 5, 2);

$diff = (($year_now - $year_last) * 12) + ($month_now - $month_last);

$limit = intval($limit);

if ($limit > 0) {
    $diff = min($limit, $diff);
}

$archive_query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, count(ID) as posts FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = '$post_type' GROUP BY YEAR(post_date), MONTH(post_date) ORDER BY post_date DESC";

$results = $wpdb->get_results($archive_query);

这段代码首先获取当前时间和最新发布的文章的日期，然后计算出需要显示的月份数量。接着，它构建了一个 SQL 查询，该查询会从 $wpdb->posts 表中选择 post_date 的年份和月份，以及每个月发布的文章数量，并按年份和月份进行分组。最后，它使用 $wpdb->get_results 函数执行查询，并将结果存储在 $results 变量中。

2.2 type 为 yearly 的情况

与 monthly 类似，yearly 类型会查询数据库中所有文章的发布日期，并按年进行分组。

SQL 查询构建代码如下 (简化版)：

global $wpdb;

$archive_query = "SELECT YEAR(post_date) AS `year`, count(ID) as posts FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = '$post_type' GROUP BY YEAR(post_date) ORDER BY post_date DESC";

$results = $wpdb->get_results($archive_query);

可以看到，SQL 查询语句与 monthly 类型非常相似，只是分组的依据变成了 YEAR(post_date)。

2.3 type 为 daily 的情况

daily 类型会按天进行归档。

SQL 查询构建代码如下 (简化版)：

global $wpdb;

$archive_query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, DAYOFMONTH(post_date) AS `day`, count(ID) as posts FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = '$post_type' GROUP BY YEAR(post_date), MONTH(post_date), DAYOFMONTH(post_date) ORDER BY post_date DESC";

$results = $wpdb->get_results($archive_query);

这里的 SQL 查询语句增加了 DAYOFMONTH(post_date)，按年、月、日进行分组。

2.4 type 为 weekly 的情况

weekly 类型按周进行归档，稍微复杂一些。

SQL 查询构建代码如下 (简化版)：

global $wpdb, $wp_locale;

$now = current_time('mysql', 1);
$lastpost = $wpdb->get_var("SELECT post_date FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = '$post_type' ORDER BY post_date DESC LIMIT 1");

// Prepare date limits
$year_last  = substr($lastpost, 0, 4);
$month_last = substr($lastpost, 5, 2);
$day_last   = substr($lastpost, 8, 2);

$year_now   = substr($now, 0, 4);
$month_now  = substr($now, 5, 2);
$day_now    = substr($now, 8, 2);

$diff = (strtotime("$year_now-$month_now-$day_now") - strtotime("$year_last-$month_last-$day_last")) / (60*60*24*7);

$limit = intval($limit);

if ($limit > 0) {
    $diff = min($limit, $diff);
}

// The database query
$archive_query = "SELECT WEEK(post_date, $start_of_week) AS `week`, YEAR(post_date) AS yr, DATE_FORMAT(post_date, '%Y %m %d') AS day FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = '$post_type' GROUP BY WEEK(post_date, $start_of_week), YEAR(post_date) ORDER BY post_date DESC";

$results = $wpdb->get_results($archive_query);

这里使用了 WEEK(post_date, $start_of_week) 函数来获取文章发布日期所在的周数。 $start_of_week 变量表示一周的开始日期（0 表示星期日，1 表示星期一，以此类推）。这个值通常从 WordPress 的设置中获取。

2.5 type 为 postbypost 的情况

postbypost 类型会列出所有文章的标题。

SQL 查询构建代码如下 (简化版)：

global $wpdb;

$archive_query = "SELECT ID, post_title, post_date FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = '$post_type' ORDER BY post_date DESC";

if ($limit > 0) {
    $archive_query .= " LIMIT $limit";
}

$results = $wpdb->get_results($archive_query);

这个查询语句直接从 $wpdb->posts 表中选择 ID、post_title 和 post_date，并按 post_date 降序排列。

2.6 type 为 alpha 的情况

alpha 类型会按文章标题的字母顺序排列文章。

SQL 查询构建代码如下 (简化版)：

global $wpdb;

$archive_query = "SELECT ID, post_title, post_date FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = '$post_type' ORDER BY post_title ASC";

if ($limit > 0) {
    $archive_query .= " LIMIT $limit";
}

$results = $wpdb->get_results($archive_query);

这里的排序依据是 post_title，按升序排列。

3. 数据格式化和输出

在获取到归档数据后，wp_get_archives 函数会根据 format 参数的不同，将数据格式化为不同的输出格式。

format 为 html: 这是默认格式。函数会生成一个 HTML 无序列表 (<ul>)，每个归档链接都是一个列表项 (<li>)。如果 show_post_count 参数为 true，则会在链接文本后显示文章数量。例如：
```
<ul>
    <li><a href="http://example.com/2023/10/">October 2023</a> (10)</li>
    <li><a href="http://example.com/2023/09/">September 2023</a> (5)</li>
    ...
</ul>
```

format 为 option: 函数会生成一个 HTML 下拉列表选项 (<option>)。这通常用于在表单中创建一个归档选择器。例如：

<option value="http://example.com/2023/10/">October 2023 (10)</option>
<option value="http://example.com/2023/09/">September 2023 (5)</option>
...

format 为 link: 函数会生成一个简单的链接地址，没有 HTML 标签。例如：
```
http://example.com/2023/10/
http://example.com/2023/09/
...
```

format 为 custom: 这种格式允许你完全自定义输出格式。你可以使用 before 和 after 参数来指定在每个归档链接前后添加的内容。例如：

$args = array(
    'type'   => 'monthly',
    'format' => 'custom',
    'before' => '<p>归档：',
    'after'  => '</p>'
);
wp_get_archives( $args );

这段代码会生成如下输出：

<p>归档：<a href="http://example.com/2023/10/">October 2023</a></p>
<p>归档：<a href="http://example.com/2023/09/">September 2023</a></p>
...

4. URL 生成

wp_get_archives 函数内部使用 get_month_link(), get_year_link(), get_day_link() 和 get_permalink() 等函数来生成归档链接的 URL。这些函数会根据 WordPress 的永久链接设置来生成相应的 URL。

例如，如果你的永久链接设置为 /year/month/day/post-name/，那么 get_month_link(2023, 10) 将会生成 http://example.com/2023/10/。

5. date_format 参数

date_format 参数允许你自定义 monthly、yearly 和 daily 归档链接的文本显示格式。默认情况下，monthly 使用 WordPress 的 "月份名称年份" 格式，yearly 使用 "年份" 格式，daily 使用 WordPress 设置中定义的日期格式。

你可以使用 PHP 的 date() 函数支持的任何格式字符串来自定义日期格式。例如，如果你想将 monthly 归档链接显示为 "年-月"，你可以这样设置：

$args = array(
    'type'        => 'monthly',
    'date_format' => 'Y-m'
);
wp_get_archives( $args );

6. 性能优化

wp_get_archives 函数会执行 SQL 查询，因此在大型网站上可能会影响性能。以下是一些优化技巧：

使用缓存: 可以使用 WordPress 的对象缓存或瞬态缓存来缓存 wp_get_archives 函数的输出结果。这样可以避免每次都执行 SQL 查询。
限制数量: 使用 limit 参数限制显示的归档数量。
索引优化: 确保 $wpdb->posts 表的 post_date 列上有索引。这可以加快 SQL 查询的速度。
避免在循环中使用: 尽量避免在循环中使用 wp_get_archives 函数。如果需要在循环中使用，请将结果缓存起来，并在循环中使用缓存的结果。

7. 案例分析

假设我们需要在网站的侧边栏创建一个按月归档的下拉列表，并显示每个月发布的文章数量。我们可以使用以下代码：

<?php
$args = array(
    'type'            => 'monthly',
    'format'          => 'option',
    'show_post_count' => true
);
?>
<select name="archive-dropdown" onchange="document.location.href=this.options[this.selectedIndex].value;">
    <option value=""><?php echo esc_attr( __( 'Select Month' ) ); ?></option>
    <?php wp_get_archives( $args ); ?>
</select>

这段代码首先定义了一个参数数组 $args，指定了归档类型为 monthly，格式为 option，并显示文章数量。然后，它创建了一个 HTML 下拉列表，并将 wp_get_archives 函数的输出结果插入到下拉列表中。当用户选择一个月份时，JavaScript 代码会将页面重定向到相应的归档页面。

8. 注意事项

wp_get_archives 函数默认只显示已发布的文章。如果你需要显示其他状态的文章，你需要修改 SQL 查询语句。
wp_get_archives 函数不会自动处理多语言情况。如果你的网站是多语言的，你需要使用一些插件或自定义代码来处理多语言归档。
理解 WordPress 的永久链接结构对于正确使用 wp_get_archives 函数至关重要。

今天的讲解就到这里。希望大家对 wp_get_archives 函数的内部实现有了更深入的了解。掌握了这个函数，就能灵活地构建各种形式的归档链接，提升网站的用户体验。

核心要点回顾

wp_get_archives 是一个功能强大的函数，用于生成各种类型的归档链接。理解其参数和内部实现，能帮助我们更好地定制和优化 WordPress 网站的归档功能。不同的 type 参数对应不同的 SQL 查询语句，而 format 参数决定了输出格式。

WordPress 归档链接结构生成机制深度剖析：wp_get_archives 函数详解

发表回复 取消回复

WordPress 归档链接结构生成机制深度剖析：`wp_get_archives` 函数详解

发表回复取消回复