本文详细介绍了如何利用`wpcf7_before_send_mail`钩子将外部api的响应数据集成到contact form 7的邮件内容中，以及如何将这些数据传递到前端javascript事件。通过设置邮件模板占位符和使用`str_replace`函数，开发者可以在邮件发送前动态填充内容。同时，文章还展示了如何通过`wpcf7_submission::add_result_props()`方法将数据推送到`wpcf7mailsent`事件，以供前端脚本进一步处理，提供了完整的代码示例和实践建议。
引言：集成外部API数据到Contact Form 7
在现代Web开发中，将表单提交与外部API服务进行交互是一种常见需求。例如，在用户提交Contact Form 7（CF7）表单后，可能需要调用一个外部API来获取特定信息（如客户ID、产品状态等），并将这些信息包含在发送给用户或管理员的邮件中，或者将其传递给前端的数据层进行后续分析。本文将深入探讨如何通过WordPress的钩子机制，特别是wpcf7_before_send_mail，实现这一目标，同时提供两种主要的数据集成方法：动态修改邮件内容和将数据传递至前端事件。
方法一：通过占位符动态修改邮件内容
当我们需要将API响应直接嵌入到CF7发送的邮件正文中时，最优雅的方法是使用占位符。这种方法允许我们在CF7的邮件模板中定义一个特殊标记，然后在邮件发送前，通过PHP代码将该标记替换为实际的API响应数据。
1. 核心原理
wpcf7_before_send_mail是一个在Contact Form 7邮件发送前触发的动作钩子。它接收一个WPCF7_ContactForm对象作为参数，允许我们在邮件发送前检查或修改表单的各种属性，包括邮件内容。
2. 步骤详解
-
在Contact Form 7邮件模板中设置占位符： 在CF7编辑器的“邮件”标签页中，编辑邮件正文，插入一个独一无二的占位符，例如 {{api_response}}。这个占位符将被我们的PHP代码替换。
CF7邮件模板示例：
立即学习“前端免费学习笔记（深入）”；
尊敬的 [your-name]， 感谢您提交表单。以下是您的API响应信息： {{api_response}} 此致， 您的团队 使用wpcf7_before_send_mail钩子： 在您的主题的functions.php文件或自定义插件中，添加一个函数并将其挂载到wpcf7_before_send_mail钩子上。
获取表单提交数据并调用外部API： 在钩子函数内部，首先获取当前提交的表单数据。然后，根据这些数据构建API请求并发送。这里我们使用wp_remote_post来发送HTTP POST请求，并使用wp_remote_retrieve_body来获取API响应体。
替换邮件体中的占位符： 获取到API响应后，我们需要从表单的邮件属性中取出邮件正文，使用str_replace函数将占位符替换为API响应数据。
更新表单的邮件属性： 最后，使用$contact_form->set_properties()方法更新表单的邮件属性，确保修改后的邮件内容在发送时生效。
3. 示例代码
add_action( 'wpcf7_before_send_mail', 'kiri_cf7_api_sender' );
function kiri_cf7_api_sender( $contact_form ) {
// 确保只针对特定表单执行此逻辑
if ( 'Quote_form' === $contact_form->title ) {
$submission = WPCF7_Submission::get_instance();
if ( $submission ) {
$posted_data = $submission->get_posted_data();
// 从提交数据中获取所需字段
$name = $posted_data['your-name'];
$surname = $posted_data['your-name2'];
$phone = $posted_data['tel-922'];
$urltest = $posted_data['dynamichidden-739']; // 假设这是一个用于判断API端点的字段
$api_url = '';
// 根据urltest的值确定API端点
if ( strpos( $urltest, '?phone' ) !== false ) {
$api_url = 'https://api.example.com/phone-endpoint';
} elseif ( strpos( $urltest, '?email' ) !== false ) {
$api_url = 'https://api.example.com/email-endpoint';
} else {
$api_url = 'https://api.example.com/default-endpoint';
}
$api_response_body = '';
if ( ! empty( $api_url ) ) {
// 构建API请求参数 (示例：将表单数据作为API请求体)
$api_args = array(
'body' => json_encode( array(
'name' => $name,
'surname' => $surname,
'phone' => $phone,
) ),
'headers' => array(
'Content-Type' => 'application/json',
// 'Authorization' => 'Bearer YOUR_API_KEY', // 如果需要API认证
),
'timeout' => 30, // 设置API请求超时时间
);
$response = wp_remote_post( $api_url, $api_args );
// 检查API请求是否成功
if ( ! is_wp_error( $response ) && wp_remote_retrieve_response_code( $response ) === 200 ) {
$api_response_body = wp_remote_retrieve_body( $response );
// 如果API响应是JSON，需要进行解码
// $api_data = json_decode( $api_response_body, true );
// $api_response_body = $api_data['some_field'] ?? 'API响应字段缺失';
} else {
error_log( 'API请求失败或返回错误：' . ( is_wp_error( $response ) ? $response->get_error_message() : wp_remote_retrieve_response_code( $response ) ) );
$api_response_body = 'API请求失败，请稍后再试。';
}
}
// 获取邮件配置
$mail = $contact_form->prop( 'mail' );
// 替换邮件正文中的占位符
// 假设API响应是简单的字符串，如果需要提取特定字段，请先json_decode
// 示例：$mail['body'] = str_replace( '{{api_response}}', $api_data['field'] , $mail['body'] );
$mail['body'] = str_replace( '{{api_response}}', $api_response_body, $mail['body'] );
// 更新表单的邮件属性
$contact_form->set_properties( array( 'mail' => $mail ) );
// 可选：将API响应添加到提交结果中，供前端JavaScript使用
// 详见方法二
$submission->add_result_props( array( 'my_api_response' => $api_response_body ) );
}
}
}方法二：将API响应数据传递至前端事件
有时，我们可能不需要将API响应直接显示在邮件中，而是希望将其传递给前端JavaScript，以便在表单提交成功后执行特定的客户端逻辑，例如更新UI、发送数据到数据层（如Google Tag Manager）或触发其他第三方脚本。Contact Form 7为此提供了一个wpcf7mailsent事件，我们可以利用WPCF7_Submission::add_result_props()方法将数据附加到这个事件中。
1. 应用场景
- 需要将API响应用于客户端数据分析或跟踪。
- 需要在表单提交成功后根据API响应动态修改页面内容。
- 与第三方JavaScript库或服务进行集成。
2. 实现方式
在wpcf7_before_send_mail钩子函数中，获取API响应后，使用$submission->add_result_props( array( 'your_key' => $your_data ) );将数据添加到提交结果中。这些数据将在wpcf7mailsent事件的event.detail对象中可用。
3. 前端监听
在前端JavaScript中，通过document.addEventListener('wpcf7mailsent', function(event) { ... });来监听表单提交成功事件，并从event.detail中获取我们添加的数据。
4. 示例代码
PHP代码片段（在方法一的kiri_cf7_api_sender函数中）：
// ... (API调用和响应处理部分，与方法一相同) ... // 在更新邮件属性之后，将API响应添加到提交结果中 // 假设 $api_response_body 包含了API的原始响应或处理后的数据 $submission->add_result_props( array( 'my_api_response' => $api_response_body ) ); // ... (函数结束) ...
JavaScript事件监听代码：
将以下JavaScript代码添加到您的主题的footer.php文件（在
