digitalpulsebe/craft-friendly-captcha

将友好的验证码集成到Craft CMS表单中,以防止垃圾邮件

3.0.1 2024-03-05 15:09 UTC

README

将友好的验证码集成到Craft CMS表单中,以防止垃圾邮件

Screenshot

需求

此插件需要Craft CMS 3、4或5

安装

要安装插件,请按照以下说明操作。

  1. 打开您的终端并转到您的Craft项目

    cd /path/to/project
    
  2. 然后告诉Composer加载插件

    composer require digitalpulsebe/craft-friendly-captcha
    

    当使用Craft 3.x时使用插件版本1

    composer require digitalpulsebe/craft-friendly-captcha:^1.0.0
    
  3. 在控制面板中,转到设置 → 插件,然后单击“安装”按钮安装Friendly Captcha。或者运行

    php craft plugin/install friendly-captcha
    

Friendly Captcha密钥

为Friendly Captcha创建一个账户 https://friendlycaptcha.com/

生成一个sitekey和一个API key,并将它们放入插件设置或.env文件中

配置Friendly Captcha

Screenshot

使用Friendly Captcha

在您希望使用的每个表单中,您需要在表单内部渲染小部件。

在您的模板中,将以下内容放在<form>标签内

{{ craft.friendlyCaptcha.renderWidget() }}

您需要在设置中启用您想要验证的表单

  • 联系表单 插件 (Submission::EVENT_BEFORE_VALIDATE)
  • 用户注册表单 (User::EVENT_BEFORE_VALIDATE)

当您想在自定义控制器中验证请求时运行此操作

use digitalpulsebe\friendlycaptcha\FriendlyCaptcha;

// ...

if (!FriendlyCaptcha::$plugin->validate->validateRequest()) {
   // add error here
}

要在您的表单中显示错误消息,请使用提交对象(检查您使用的控制器实现)

{{ craft.friendlyCaptcha.renderWidget() }}
{{ submission ? _self.errorList(submission.getErrors('friendlyCaptcha')) }}

与Formie一起使用Friendly Captcha

使用 digitalpulse/craft-formie-friendly-captcha 插件与Formie一起使用。

小部件选项

您可以将一个属性数组传递给renderWidget()函数。请参阅Friendly Captcha文档中的属性API HTML标签部分。

示例

{{ craft.friendlyCaptcha.renderWidget({'data-lang': 'fr'}) }}

归属

Friendly Captcha小部件和标志属于Friendly Captcha