如何利用WordPress的`Rewrite API`实现复杂的自定义URL重写规则？ - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

WordPress Rewrite API 高级应用：构建复杂自定义 URL 重写规则

各位同学，大家好！今天我们来深入探讨 WordPress 的 Rewrite API，并学习如何利用它来实现复杂的自定义 URL 重写规则。Rewrite API 是 WordPress 提供的一个强大工具，允许我们修改 WordPress 的默认 URL 结构，使其更符合我们的需求，例如优化 SEO、创建更友好的用户体验，以及构建自定义应用。

1. 理解 Rewrite API 的基本概念

在深入复杂应用之前，我们先回顾一下 Rewrite API 的基本概念。Rewrite API 主要涉及两个关键函数：

add_rewrite_rule()： 用于定义一个新的重写规则。它接受三个参数：
- $regex：一个正则表达式，用于匹配传入的 URL。
- $redirect：一个目标 URL，当匹配到 $regex 时，WordPress 会将请求重定向到这个 URL。
- $priority：可选参数，指定重写规则的优先级。默认为 ‘top’。
add_rewrite_tag()： 用于定义一个新的查询变量。查询变量允许我们从重写后的 URL 中提取信息，并在 WordPress 查询中使用。它接受两个参数：
- $tag：查询变量的名称。
- $regex：一个正则表达式，用于匹配 URL 中该查询变量的值。

Rewrite API 的工作流程大致如下：

当用户访问一个 URL 时，WordPress 会遍历所有已注册的重写规则。
如果找到一个匹配的规则，WordPress 会将 URL 重写为 $redirect 中指定的格式。
如果 $redirect 中包含了查询变量，WordPress 会提取这些变量的值，并将它们添加到 $_GET 全局数组中。
WordPress 根据 $_GET 中的查询变量执行相应的查询。

重要提示： 每次添加、修改或删除重写规则后，必须刷新 WordPress 的重写规则。这可以通过访问 WordPress 后台的 "设置 -> 固定链接" 页面并点击 "保存更改" 按钮来完成。也可以在代码中使用 flush_rewrite_rules() 函数。

2. 构建复杂重写规则的步骤

构建复杂重写规则通常涉及以下几个步骤：

规划 URL 结构： 明确你想要实现的 URL 结构是什么样的。
定义重写规则： 使用正则表达式定义匹配 URL 的规则，并指定重写后的 URL。
定义查询变量： 定义从 URL 中提取信息的查询变量。
编写代码： 使用 add_rewrite_rule() 和 add_rewrite_tag() 函数将规则和变量添加到 WordPress。
刷新重写规则： 使用 flush_rewrite_rules() 函数刷新重写规则。
处理查询： 在你的模板或插件代码中，使用 get_query_var() 函数获取查询变量的值，并根据这些值执行相应的操作。

3. 复杂重写规则的案例分析

下面我们通过几个案例来演示如何构建复杂的重写规则。

案例 1：自定义文章类型的分级目录结构

假设我们有一个自定义文章类型 product，我们希望为它创建一个分级目录结构，如下所示：

/products/category/subcategory/product-name/

其中 category 和 subcategory 是自定义分类法，product-name 是文章的别名。

步骤 1：定义 URL 结构

我们的 URL 结构已经明确：/products/category/subcategory/product-name/

步骤 2：定义重写规则

我们需要定义一个重写规则来匹配这种 URL 结构，并将其重写为 WordPress 可以理解的形式。

function custom_rewrite_rules() {
    add_rewrite_rule(
        '^products/([^/]*)/([^/]*)/([^/]*)/?$',
        'index.php?post_type=product&product_category=$matches[1]&product_subcategory=$matches[2]&name=$matches[3]',
        'top'
    );
}
add_action( 'init', 'custom_rewrite_rules' );

在这个规则中：

^products/([^/]*)/([^/]*)/([^/]*)/?$ 是一个正则表达式，用于匹配 URL。
- ^products/ 匹配 URL 的开头。
- ([^/]*) 匹配任意数量的非斜杠字符，并将其捕获到 $matches 数组中。
- /?$ 匹配可选的斜杠，以及 URL 的结尾。
index.php?post_type=product&product_category=$matches[1]&product_subcategory=$matches[2]&name=$matches[3] 是重写后的 URL。
- post_type=product 指定查询的文章类型。
- product_category=$matches[1] 将第一个捕获组的值（category）赋值给 product_category 查询变量。
- product_subcategory=$matches[2] 将第二个捕获组的值（subcategory）赋值给 product_subcategory 查询变量。
- name=$matches[3] 将第三个捕获组的值（product-name）赋值给 name 查询变量（文章别名）。

步骤 3：定义查询变量

我们需要定义 product_category 和 product_subcategory 这两个查询变量。

function custom_rewrite_tags() {
    add_rewrite_tag( '%product_category%', '([^/]*)' );
    add_rewrite_tag( '%product_subcategory%', '([^/]*)' );
}
add_action( 'init', 'custom_rewrite_tags' );

步骤 4：刷新重写规则

function custom_flush_rewrite_rules() {
    custom_rewrite_rules();
    flush_rewrite_rules();
}
register_activation_hook( __FILE__, 'custom_flush_rewrite_rules' );

这段代码会在插件激活时刷新重写规则。

步骤 5：处理查询

在 product 文章类型的模板文件中，我们可以使用 get_query_var() 函数获取查询变量的值。

$category = get_query_var( 'product_category' );
$subcategory = get_query_var( 'product_subcategory' );

echo 'Category: ' . $category . '<br>';
echo 'Subcategory: ' . $subcategory . '<br>';

案例 2：分页处理

假设我们需要为某个自定义页面添加分页功能，并使用自定义的 URL 结构。

/my-page/page/2/

步骤 1：定义 URL 结构

URL 结构已经明确：/my-page/page/2/

步骤 2：定义重写规则

function custom_rewrite_rules_pagination() {
    add_rewrite_rule(
        '^my-page/page/([0-9]+)/?$',
        'index.php?pagename=my-page&paged=$matches[1]',
        'top'
    );
}
add_action( 'init', 'custom_rewrite_rules_pagination' );

在这个规则中：

^my-page/page/([0-9]+)/?$ 是一个正则表达式，用于匹配 URL。
- ^my-page/page/ 匹配 URL 的开头。
- ([0-9]+) 匹配一个或多个数字，并将其捕获到 $matches 数组中。
- /?$ 匹配可选的斜杠，以及 URL 的结尾。
index.php?pagename=my-page&paged=$matches[1] 是重写后的 URL。
- pagename=my-page 指定页面别名为 my-page。
- paged=$matches[1] 将第一个捕获组的值（页码）赋值给 paged 查询变量。

步骤 3：定义查询变量

paged 是 WordPress 默认的查询变量，因此我们不需要显式地定义它。

步骤 4：刷新重写规则

function custom_flush_rewrite_rules_pagination() {
    custom_rewrite_rules_pagination();
    flush_rewrite_rules();
}
register_activation_hook( __FILE__, 'custom_flush_rewrite_rules_pagination' );

步骤 5：处理查询

在 my-page 页面模板文件中，我们可以使用 get_query_var() 函数获取页码。

$paged = ( get_query_var( 'paged' ) ) ? get_query_var( 'paged' ) : 1;

echo 'Page: ' . $paged . '<br>';

然后，我们可以使用 $paged 变量来构建分页链接和执行分页查询。

案例 3：处理复杂的日期和分类结构

假设我们需要创建一个新闻站点，并使用以下 URL 结构：

/news/2023/10/category-name/article-title/

步骤 1：定义 URL 结构

URL 结构已经明确。

步骤 2：定义重写规则

function custom_rewrite_rules_news() {
    add_rewrite_rule(
        '^news/([0-9]{4})/([0-9]{2})/([^/]*)/([^/]*)/?$',
        'index.php?post_type=post&year=$matches[1]&monthnum=$matches[2]&category_name=$matches[3]&name=$matches[4]',
        'top'
    );
}
add_action( 'init', 'custom_rewrite_rules_news' );

在这个规则中：

^news/([0-9]{4})/([0-9]{2})/([^/]*)/([^/]*)/?$ 是一个正则表达式，用于匹配 URL。
- ^news/ 匹配 URL 的开头。
- ([0-9]{4}) 匹配 4 位数字（年份），并将其捕获到 $matches 数组中。
- ([0-9]{2}) 匹配 2 位数字（月份），并将其捕获到 $matches 数组中。
- ([^/]*) 匹配任意数量的非斜杠字符（分类名），并将其捕获到 $matches 数组中。
- ([^/]*) 匹配任意数量的非斜杠字符（文章别名），并将其捕获到 $matches 数组中。
- /?$ 匹配可选的斜杠，以及 URL 的结尾。
index.php?post_type=post&year=$matches[1]&monthnum=$matches[2]&category_name=$matches[3]&name=$matches[4] 是重写后的 URL。
- post_type=post 指定文章类型为 post。
- year=$matches[1] 将年份赋值给 year 查询变量。
- monthnum=$matches[2] 将月份赋值给 monthnum 查询变量。
- category_name=$matches[3] 将分类名赋值给 category_name 查询变量。
- name=$matches[4] 将文章别名赋值给 name 查询变量。

步骤 3：定义查询变量

year, monthnum, category_name, name 都是 WordPress 默认的查询变量，因此我们不需要显式地定义它们。

步骤 4：刷新重写规则

function custom_flush_rewrite_rules_news() {
    custom_rewrite_rules_news();
    flush_rewrite_rules();
}
register_activation_hook( __FILE__, 'custom_flush_rewrite_rules_news' );

步骤 5：处理查询

WordPress 会自动根据这些查询变量执行相应的查询，并在文章页面显示内容。

4. 注意事项

正则表达式： 编写正确的正则表达式是成功构建重写规则的关键。务必仔细测试你的正则表达式，确保它能够正确匹配你想要的 URL 结构。
优先级： 重写规则的优先级很重要。如果多个规则匹配同一个 URL，WordPress 会使用优先级最高的规则。你可以通过 $priority 参数来控制规则的优先级。
性能： 复杂的重写规则可能会影响 WordPress 的性能。尽量保持规则的简洁和高效。
冲突： 确保你的重写规则不会与其他插件或主题的规则冲突。
调试： 使用 flush_rewrite_rules() 函数后，务必检查 WordPress 的 .htaccess 文件（如果你的服务器使用 Apache）或 Nginx 的配置文件，确保重写规则已正确添加。可以使用 global $wp_rewrite; print_r($wp_rewrite); 来查看当前的rewrite规则对象。
编码规范： 遵循 WordPress 的编码规范，确保你的代码易于阅读和维护。

5. 表格总结 Rewrite API 重要函数

函数名	描述	参数
`add_rewrite_rule()`	添加一个新的重写规则。	`$regex` (string): 用于匹配 URL 的正则表达式。 `$redirect` (string): 重写后的 URL。 `$priority` (string, optional): 规则的优先级 (‘top’ 或 ‘bottom’，默认为 ‘top’)。
`add_rewrite_tag()`	添加一个新的查询变量。	`$tag` (string): 查询变量的名称，必须以 `%` 开头和结尾。 `$regex` (string): 用于匹配 URL 中该查询变量的值的正则表达式。
`flush_rewrite_rules()`	刷新 WordPress 的重写规则。	`$hard` (bool, optional): 是否强制刷新（更新 .htaccess 文件）。默认为 `true`。
`get_query_var()`	获取查询变量的值。	`$var` (string): 查询变量的名称。 `$default` (mixed, optional): 如果查询变量不存在，则返回的默认值。默认为空字符串。
`WP_Rewrite`	WordPress 的重写规则类。可以通过 `global $wp_rewrite;` 访问该类的实例，并使用其属性和方法来管理重写规则。例如，`$wp_rewrite->rules` 属性包含了所有已注册的重写规则，`$wp_rewrite->flush_rules()` 方法等同于 `flush_rewrite_rules()` 函数。	/

灵活运用Rewrite API，创建更佳用户体验

通过今天的学习，我们了解了如何利用 WordPress 的 Rewrite API 构建复杂的自定义 URL 重写规则。掌握了这些技术，我们可以创建更符合我们需求的 URL 结构，优化 SEO，并为用户提供更好的浏览体验。希望大家在实际项目中灵活运用这些知识，构建出更加强大的 WordPress 应用。

WordPress Rewrite API 高级应用：构建复杂自定义 URL 重写规则

1. 理解 Rewrite API 的基本概念

2. 构建复杂重写规则的步骤

3. 复杂重写规则的案例分析

4. 注意事项

5. 表格总结 Rewrite API 重要函数

灵活运用Rewrite API，创建更佳用户体验

发表回复 取消回复

发表回复取消回复