研究 WordPress rewrite_tag 与 rewrite_rule 的协同关系 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

WordPress Rewrite Tag 与 Rewrite Rule 协同关系详解

各位朋友，大家好！今天我们来深入探讨 WordPress 中 rewrite_tag 和 rewrite_rule 这两个重要概念的协同关系。理解它们如何协同工作对于构建复杂、定制化的 WordPress 站点至关重要。

1. WordPress Permalink 结构与 Rewrite 机制

在深入了解 rewrite_tag 和 rewrite_rule 之前，我们需要先理解 WordPress 的 Permalink 结构和 Rewrite 机制。

WordPress 使用 Permalink（永久链接）来标识每个页面、文章、分类等。这些 Permalink 决定了用户在浏览器地址栏中看到的 URL。WordPress 默认提供了一些 Permalink 结构选项，例如：

Plain: /?p=123 (最不友好的)
Day and name: /%year%/%monthnum%/%day%/%postname%/
Month and name: /%year%/%monthnum%/%postname%/
Numeric: /archives/%post_id%
Post name: /%postname%/
Custom Structure: 允许自定义 Permalink 结构，例如 /%category%/%postname%/

用户在 WordPress 后台设置的 Permalink 结构，实际上定义了一套规则，用于将用户访问的 URL 映射到 WordPress 内部的查询参数。这个映射过程就是通过 Rewrite 机制实现的。

Rewrite 机制的核心是 .htaccess 文件（或者 Nginx 等服务器的配置文件），它包含了 Rewrite Rules，这些规则告诉服务器如何将特定的 URL 重定向到 WordPress 的 index.php 文件，并传递相应的查询参数。

当用户访问一个 Permalink 时，服务器会根据 .htaccess 文件中的 Rewrite Rules，将 URL 重定向到 index.php，然后 WordPress 会解析 URL 并确定要显示的内容。

2. Rewrite Tag 的作用与定义

rewrite_tag 的作用是定义一个用于 Permalink 结构的占位符。这个占位符可以在 Permalink 结构中使用，并会在 Rewrite Rule 中被替换为对应的正则表达式。

换句话说，rewrite_tag 允许你自定义 Permalink 结构中的变量部分，例如，你想在 URL 中包含文章的作者名，就可以定义一个 rewrite_tag 来表示作者名。

rewrite_tag 的定义通常在主题或插件的 functions.php 文件中进行，使用 add_rewrite_tag() 函数：

/**
 * 添加自定义 rewrite tag
 * @param string $tag rewrite tag 的名称，例如 '%author%'
 * @param string $regex 用于匹配 tag 值的正则表达式
 * @param string $query 用于替换 tag 的查询变量名
 */
add_rewrite_tag( $tag, $regex, $query );

$tag (string): 要定义的 rewrite tag 的名称，必须以 % 开始和结束。例如：%author%。
$regex (string): 用于匹配 rewrite tag 值的正则表达式。例如：([^/]+) 表示匹配一个或多个非斜杠字符。
$query (string): 用于替换 rewrite tag 的查询变量名。这个变量名会在 WordPress 的查询参数中使用。例如：author_name。

示例：定义一个用于匹配作者名的 rewrite tag

假设我们想在 URL 中包含作者名，可以这样定义 rewrite tag：

function custom_rewrite_tags() {
    add_rewrite_tag( '%author_name%', '([^/]+)', 'author_name=' );
}
add_action( 'init', 'custom_rewrite_tags' );

在这个例子中：

%author_name% 是 rewrite tag 的名称。
([^/]+) 是用于匹配作者名的正则表达式。
author_name= 是用于替换 rewrite tag 的查询变量名。

3. Rewrite Rule 的作用与定义

rewrite_rule 的作用是定义一个 URL 重写规则。这个规则告诉 WordPress 如何将特定的 URL 映射到内部的查询参数。

rewrite_rule 的定义通常在主题或插件的 functions.php 文件中进行，使用 add_rewrite_rule() 函数：

/**
 * 添加 rewrite rule
 * @param string $regex 用于匹配 URL 的正则表达式
 * @param string $redirect 用于替换 URL 的字符串，通常是 index.php 和查询参数
 * @param string $after 应用 rewrite rule 的上下文，可选 'top' 或 'bottom'，默认为 'bottom'
 */
add_rewrite_rule( $regex, $redirect, $after );

$regex (string): 用于匹配 URL 的正则表达式。
$redirect (string): 用于替换 URL 的字符串，通常是 index.php 和查询参数。
$after (string): 应用 rewrite rule 的上下文，可选 'top' 或 'bottom'，默认为 'bottom'。 'top' 表示将该规则添加到规则列表的顶部，优先应用； 'bottom' 表示添加到规则列表的底部，最后应用。

示例：定义一个用于包含作者名的 Rewrite Rule

假设我们已经定义了 %author_name% 这个 rewrite tag，现在需要定义一个 rewrite rule，将包含作者名的 URL 映射到 WordPress 的查询参数。

function custom_rewrite_rules( $rules ) {
    $new_rules = array();
    $new_rules['author/([^/]+)/?$'] = 'index.php?author_name=$matches[1]';
    return array_merge( $new_rules, $rules );
}
add_filter( 'rewrite_rules_array', 'custom_rewrite_rules' );

在这个例子中：

author/([^/]+)/?$ 是用于匹配 URL 的正则表达式。它匹配以 author/ 开头，后跟一个或多个非斜杠字符，最后可以有一个斜杠的 URL。
index.php?author_name=$matches[1] 是用于替换 URL 的字符串。它将 URL 重定向到 index.php，并将匹配到的作者名作为 author_name 查询参数的值。 $matches[1] 表示正则表达式中第一个括号匹配到的内容。

4. Rewrite Tag 与 Rewrite Rule 的协同关系

rewrite_tag 和 rewrite_rule 协同工作，共同定义了 WordPress 的 Permalink 结构和 Rewrite 机制。

定义 Rewrite Tag： 首先，使用 add_rewrite_tag() 定义一个 rewrite tag，指定其名称、正则表达式和查询变量名。
在 Permalink 结构中使用 Rewrite Tag： 在 WordPress 后台的 Permalink 设置中，可以使用定义的 rewrite tag 来构建自定义 Permalink 结构。例如，可以将 Permalink 结构设置为 /%category%/%author_name%/%postname%/。
定义 Rewrite Rule： 使用 add_rewrite_rule() 定义一个 rewrite rule，用于匹配包含 rewrite tag 的 URL，并将 URL 映射到 WordPress 的查询参数。
WordPress 解析 URL： 当用户访问一个包含 rewrite tag 的 URL 时，WordPress 会根据 Rewrite Rule 将 URL 重定向到 index.php，并将 rewrite tag 的值作为查询参数传递给 WordPress。
WordPress 根据查询参数显示内容： WordPress 会根据查询参数（例如 author_name）来确定要显示的内容。

示例：完整的作者名 Permalink 实现

下面是一个完整的示例，演示如何使用 rewrite_tag 和 rewrite_rule 实现包含作者名的 Permalink。

步骤 1：定义 Rewrite Tag

function custom_rewrite_tags() {
    add_rewrite_tag( '%author_name%', '([^/]+)', 'author_name=' );
}
add_action( 'init', 'custom_rewrite_tags' );

步骤 2：定义 Rewrite Rule

function custom_rewrite_rules( $rules ) {
    $new_rules = array();
    $new_rules['author/([^/]+)/?$'] = 'index.php?author_name=$matches[1]';
    return array_merge( $new_rules, $rules );
}
add_filter( 'rewrite_rules_array', 'custom_rewrite_rules' );

步骤 3：更新 Permalink 结构

在 WordPress 后台的 Permalink 设置中，将 Permalink 结构设置为 /%author_name%/%postname%/ 或者 author/%author_name%/%postname%/。

步骤 4：刷新 Rewrite Rules

在修改了 Permalink 结构或添加了 rewrite rule 之后，需要刷新 Rewrite Rules，才能使新的规则生效。可以通过以下几种方式刷新 Rewrite Rules：

保存 Permalink 设置： 在 WordPress 后台的 Permalink 设置中，即使没有修改 Permalink 结构，也点击“保存更改”按钮，即可刷新 Rewrite Rules。
使用 flush_rewrite_rules() 函数： 在主题或插件的 functions.php 文件中，可以使用 flush_rewrite_rules() 函数来刷新 Rewrite Rules。注意： 这是一个代价较高的操作，不应该在每次页面加载时都执行，而应该在主题或插件激活时执行一次。

function custom_rewrite_flush() {
    // 注意：只有在主题或插件激活时才执行此操作
    flush_rewrite_rules();
}
register_activation_hook( __FILE__, 'custom_rewrite_flush' ); // __FILE__ 是当前文件路径

步骤 5：获取作者名并生成 URL

为了让 URL 包含作者名，我们需要在文章链接中插入作者名。例如，可以使用以下代码获取作者名并生成 URL：

$author_name = get_the_author_meta( 'user_nicename', get_the_author_meta( 'ID' ) ); // 获取作者的 user_nicename 作为作者名
$post_link = get_permalink();
$author_link = home_url( '/author/' . $author_name . '/' . basename( $post_link ) );

echo '<a href="' . esc_url( $author_link ) . '">' . get_the_title() . '</a>';

在这个例子中，我们使用 get_the_author_meta() 函数获取作者的 user_nicename 作为作者名，然后使用 home_url() 函数生成包含作者名的 URL。 basename( $post_link ) 是为了从文章的链接中提取出文章名部分。

5. 常见问题与注意事项

Rewrite Rules 不生效： 最常见的问题是 Rewrite Rules 不生效。这通常是由于以下原因：
- 忘记刷新 Rewrite Rules： 在修改了 Permalink 结构或添加了 rewrite rule 之后，必须刷新 Rewrite Rules，才能使新的规则生效。
- .htaccess 文件权限不足： WordPress 需要写入 .htaccess 文件的权限。如果权限不足，WordPress 无法更新 Rewrite Rules。
- 服务器配置问题： 有些服务器配置可能禁止使用 .htaccess 文件，或者需要进行额外的配置才能启用 Rewrite 功能。
- Rewrite Rule 冲突： 多个 rewrite rule 可能会发生冲突，导致某些规则无法生效。需要仔细检查 rewrite rule 的正则表达式，确保它们不会互相干扰。
正则表达式错误： rewrite_tag 和 rewrite_rule 都使用正则表达式来匹配 URL。如果正则表达式错误，会导致 URL 匹配失败。
查询变量名冲突： rewrite_tag 定义的查询变量名不能与 WordPress 内部的查询变量名冲突。
性能问题： 过多的 rewrite rule 会影响 WordPress 的性能。应该尽量减少 rewrite rule 的数量，并优化正则表达式的效率。
使用 flush_rewrite_rules() 函数要谨慎： 频繁调用 flush_rewrite_rules() 会消耗大量的服务器资源。应该只在主题或插件激活时调用一次。
调试 Rewrite Rules： 可以使用插件（例如 "Rewrite Rules Inspector"）来查看 WordPress 的 Rewrite Rules，并进行调试。

6. 使用场景示例

使用场景	说明	示例代码
自定义文章类型存档页的 Permalink	假设你创建了一个自定义文章类型 `book`，并且希望它的存档页的 Permalink 结构为 `/books/year/2023/`，其中 `2023` 是年份。	`php // 定义 rewrite tag add_rewrite_tag( '%book_year%', '([0-9]{4})', 'book_year=' ); // 定义 rewrite rule add_rewrite_rule( 'books/year/([0-9]{4})/?$', 'index.php?post_type=book&book_year=$matches[1]', 'top' );`
自定义分类目录的 Permalink	你希望为某个特定的分类目录创建一个自定义的 Permalink，例如 `/special-category/category-name/`。	php // 定义 rewrite tag add_rewrite_tag( '%special_category%', '([^/]+)', 'special_category=' ); // 定义 rewrite rule add_rewrite_rule( 'special-category/([^/]+)/?$', 'index.php?category_name=$matches[1]&special_category=1', 'top' ); // 获取分类目录链接时，修改链接 add_filter('category_link', 'custom_category_link', 10, 2); function custom_category_link( $link, $category_id ) { $category = get_category( $category_id ); if ( $category->slug == 'your-category-slug' ) { return home_url( 'special-category/' . $category->slug . '/' ); } return $link; }
处理分页的 Permalink	当你的自定义文章类型或分类目录有多个页面时，你需要处理分页的 Permalink，例如 `/books/year/2023/page/2/`。	`php // 定义 rewrite tag add_rewrite_tag( '%book_year%', '([0-9]{4})', 'book_year=' ); // 定义 rewrite rule add_rewrite_rule( 'books/year/([0-9]{4})/page/([0-9]+)/?$', 'index.php?post_type=book&book_year=$matches[1]&paged=$matches[2]', 'top' ); add_rewrite_rule( 'books/year/([0-9]{4})/?$', 'index.php?post_type=book&book_year=$matches[1]', 'top' );`
为自定义文章类型添加自定义查询参数	假设你希望根据文章的某个自定义字段（例如 `color`）进行查询，并且希望 Permalink 结构为 `/books/color/red/`。	php // 定义 rewrite tag add_rewrite_tag( '%book_color%', '([^/]+)', 'book_color=' ); // 定义 rewrite rule add_rewrite_rule( 'books/color/([^/]+)/?$', 'index.php?post_type=book&book_color=$matches[1]', 'top' ); // 在 pre_get_posts 钩子中处理查询参数 add_action( 'pre_get_posts', 'custom_pre_get_posts' ); function custom_pre_get_posts( $query ) { if ( ! is_admin() && $query->is_main_query() && $query->is_post_type_archive( 'book' ) && isset( $query->query_vars['book_color'] ) ) { $query->set( 'meta_key', 'color' ); $query->set( 'meta_value', $query->query_vars['book_color'] ); } }

7. 总结与回顾

今天我们详细讲解了 WordPress 中 rewrite_tag 和 rewrite_rule 的协同关系。rewrite_tag 定义 Permalink 结构中的占位符，而 rewrite_rule 则定义 URL 重写规则，两者配合可以将自定义的 URL 映射到 WordPress 内部的查询参数。理解并掌握它们对于构建定制化的 WordPress 站点非常有帮助。希望今天的讲解对大家有所启发。