WooCommerce：基于产品自定义字段定制结账成功页重定向

概述

在 woocommerce 中，标准流程是用户完成购买后被引导至一个通用的“订单已接收”页面。然而，在某些业务场景下，我们可能需要根据用户购买的特定产品，将其重定向到一个定制的“感谢页”或外部链接。例如，如果某个产品是数字课程，购买后可能需要直接跳转到课程介绍页或注册页面。实现这一需求的关键在于，如何在结账成功后准确获取所购产品的自定义字段信息，并据此执行重定向。

常见挑战与误区

开发者在尝试实现基于产品自定义字段的重定向时，常遇到的一个挑战是如何在 order-received 页面正确获取到产品ID及其关联的自定义字段。一个常见的误区是在 template_redirect 钩子中使用 get_the_ID() 来尝试获取产品ID。在 order-received 页面上下文环境中，get_the_ID() 返回的通常是当前页面的ID（即“订单已接收”页面的ID），而不是购物车中商品的ID。因此，直接通过 get_post_meta( get_the_ID(), '_my_redirect', true ) 尝试获取产品自定义字段会失败，因为此时 get_the_ID() 并非指向任何已购产品。

要正确获取产品信息，必须通过订单对象来访问。当用户完成结账并跳转到 order-received 页面时，订单信息已经生成，我们可以通过 URL 中的订单密钥 (key) 来获取完整的订单数据。

正确的实现方案

正确的做法是利用 template_redirect 钩子，但在此钩子内部，我们需要：

硅基智能

基于Web3.0的元宇宙，去中心化的互联网，高质量、沉浸式元宇宙直播平台，用数字化重新定义直播

62

查看详情

1. 判断当前是否为 WooCommerce 的 order-received 页面。
2. 从 URL 参数中获取订单密钥，进而获取订单ID。
3. 通过订单ID实例化 WC_Order 对象。
4. 遍历订单中的所有商品，获取每个商品的ID。
5. 使用商品的ID来查询其关联的自定义字段。
6. 如果找到有效的重定向URL，则执行 wp_redirect()。

以下是实现这一功能的完整代码：

/**
 * WooCommerce：基于产品自定义字段实现结账后重定向
 * 将此代码添加到主题的 functions.php 文件或自定义插件中。
 */
add_action('template_redirect', 'custom_redirect_after_purchase_by_product_meta');

function custom_redirect_after_purchase_by_product_meta() {

    // 1. 检查是否在 WooCommerce 的 'order-received' 页面
    //    并且 URL 中包含有效的订单密钥
    if ( ! is_wc_endpoint_url('order-received') || empty($_GET['key']) ) {
        return; // 如果不是，则提前退出
    }

    // 2. 根据订单密钥获取订单ID
    $order_id = wc_get_order_id_by_order_key($_GET['key']);

    // 3. 实例化 WC_Order 对象
    if ( ! $order_id ) {
        return; // 如果订单ID无效，则退出
    }
    $order = wc_get_order($order_id);

    // 4. 遍历订单中的所有商品
    foreach ( $order->get_items() as $item ) {
        // 确保获取到的是产品ID，而不是变体ID（对于简单产品，它们相同）
        $product_id = $item->get_product_id(); 

        // 5. 获取产品的自定义字段 '_my_redirect'
        $my_redirect_url = get_post_meta($product_id, '_my_redirect', true);

        // 6. 如果自定义字段不为空，则执行重定向并退出
        if ( ! empty($my_redirect_url) ) {
            wp_redirect(esc_url($my_redirect_url)); // 使用 esc_url 确保 URL 安全
            exit; // 重定向后必须退出，防止进一步执行
        }
    }
}

代码解析

• add_action('template_redirect', 'custom_redirect_after_purchase_by_product_meta');: 将我们的自定义函数挂载到 template_redirect 钩子。这个钩子在 WordPress 决定加载哪个模板文件之前触发，是执行重定向的理想时机。
• is_wc_endpoint_url('order-received'): 这是一个 WooCommerce 辅助函数，用于检查当前页面是否是指定的 WooCommerce 端点（例如 order-received、my-account 等）。
• empty($_GET['key']): 确保 URL 中存在 key 参数，该参数包含订单密钥。
• wc_get_order_id_by_order_key($_GET['key']): 根据订单密钥获取订单的数字ID。
• wc_get_order($order_id): 通过订单ID实例化一个 WC_Order 对象，这个对象包含了订单的所有详细信息。
• $order-youjiankuohaophpcnget_items(): 获取订单中所有商品的集合。
• $item->get_product_id(): 对于订单中的每个商品项，获取其对应的产品ID。
• get_post_meta($product_id, '_my_redirect', true): 这是关键步骤，使用正确的产品ID来获取名为 _my_redirect 的自定义字段值。true 参数确保返回单个值。
• wp_redirect(esc_url($my_redirect_url)): 执行重定向。esc_url() 函数用于清理和验证 URL，防止潜在的安全问题。
• exit;: 在 wp_redirect() 之后立即调用 exit; 是非常重要的，它会终止脚本的执行，防止在重定向之后还输出其他内容或执行不必要的代码。

注意事项

1. 自定义字段键名一致性： 确保你在产品编辑页面添加的自定义字段键名与代码中的 _my_redirect 完全一致。通常，自定义字段键名以 _ 开头表示它是隐藏字段。
2. 多产品处理： 如果订单中包含多个产品，且它们都设置了 _my_redirect 字段，上述代码会根据 foreach 循环的顺序，优先重定向到第一个找到的有效 URL。如果需要更复杂的逻辑（例如，根据优先级重定向，或者合并多个重定向目标），你需要调整循环内部的逻辑。
3. URL 有效性： 确保在产品自定义字段中输入的 URL 是完整且有效的。无效的 URL 可能导致重定向失败或用户体验不佳。
4. 缓存： 如果使用了页面缓存插件，请在修改代码后清除缓存，以确保新的重定向逻辑能够生效。
5. 测试： 在生产环境部署之前，务必在开发或测试环境中进行充分的测试，以确保重定向功能按预期工作。
6. 错误处理： 虽然 esc_url 提供了一定的保护，但你可能希望添加更健壮的错误处理，例如当 get_post_meta 返回非 URL 格式的数据时。

总结

通过上述教程，我们详细讲解了如何在 WooCommerce 中，利用 template_redirect 钩子和订单对象，正确地根据产品自定义字段实现结账后的定制重定向。理解 order-received 页面上下文以及如何从订单中提取产品信息是实现此功能的关键。遵循本文提供的代码和注意事项，可以有效地提升用户体验，满足特定的业务需求。

以上就是WooCommerce：基于产品自定义字段定制结账成功页重定向的详细内容，更多请关注php中文网其它相关文章！