fsorge/cloudflare-turnstile-php

轻松验证 Cloudflare Turnstile captchas

1.0.0 2023-03-10 16:40 UTC

This package is auto-updated.

Last update: 2024-09-10 20:22:18 UTC


README

这是一个非官方的PHP包,可以轻松验证 Cloudflare Turnstile captchas。更多信息请参阅Cloudflare官方文档

要求

  • PHP >= 8.1

入门

  1. 使用Composer下载此包
composer require fsorge/cloudflare-turnstile-php
  1. 创建一个新的 Turnstile 实例
use Fsorge\Cloudflare\Turnstile;

$turnstile = new Turnstile('YOUR_SECRET_KEY');
  1. 调用 isValid() 方法
$isCaptchaValid = $turnstile->isValid('RESPONSE_FROM_CLIENT');
  1. 这就完成了!

字典

  • YOUR_SECRET_KEY:您可以前往 Cloudflare Turnstile 控制面板,点击您网站的“设置”,展开“密钥”部分,并在项目中某处复制密钥,将其传递给 Turnstile 构造函数以获取您的密钥。
  • RESPONSE_FROM_CLIENT:这是一个隐藏字段(其 name 属性设置为 cf-turnstile-response),由 Turnstile 客户端小部件自动创建在您的表单中。您必须传递该字段的值。

完整的简单示例

use Fsorge\Cloudflare\Turnstile;

$turnstile = new Turnstile('0x......');

$isCaptchaValid = $turnstile->isValid('0.id8uAhu.....');

if ($isCaptchaValid) {
    // Captcha has been validated
} else {
    // Captcha NOT validate
}

详细响应

如果您需要获取 Cloudflare Turnstile API 的完整响应,可以调用 validate() 方法而不是 isValid()

validate() 返回一个包含 Cloudflare API 整个响应的关联数组,其中包含有用的信息,如发生的错误(如果有)。