Turnstile for Silverstripe
Adds a "spam protection" field to SilverStripe userforms using Cloudflare's Turnstile service.
Maintainer Contact
- Ed Chipman (UndefinedOffset)
Requirements
Installation
composer require webbuilders-group/silverstripe-turnstile
Configuration
There are multiple configuration options for the field, you must set the site_key and the secret_key which you can get from Cloudflare/. These configuration options must be added to your site's yaml config typically this is app/\_config/config.yml.
WebbuildersGroup\Turnstile\Forms\TurnstileField:
site_key: '`TURNSTILE_SITE_KEY`' #Your site key (required)
secret_key: '`TURNSTILE_SECRET_KEY`' #Your secret key (required)
verify_ssl: true #Allows you to disable php-curl's SSL peer verification by setting this to false (optional, defaults to true)
default_theme: "light" #Default theme color (optional, light, dark or auto, defaults to light)
js_onload_callback: null #Onload callback to be called when the JS for Turnstile is loaded
proxy_server: "`SS_OUTBOUND_PROXY_SERVER`" #Your proxy server address (optional)
proxy_port: "`SS_OUTBOUND_PROXY_PORT`" #Your proxy server address port (optional)
proxy_auth: "`SS_OUTBOUND_PROXY_AUTH`" #Your proxy server authentication information (optional)
Adding field labels
If you want to add a field label or help text to the Captcha field you can do so like this:
$form->enableSpamProtection()
->Fields()
->fieldByName('Captcha')
->setTitle('Spam protection')
->setDescription('Your description here');
Adding Custom Attributes
Turnstile has a few other options that this module does not out of the box provide hooks for setting, however you can set them your self using setAttribute for example:
$form->enableSpamProtection()
->Fields()
->fieldByName('Captcha')
->setAttribute('data-action', 'action')
->setAttribute('data-cdata', 'payload')
->setAttribute('data-callback', 'yourChallengeJSCallback')
->setAttribute('data-expired-callback', 'yourExpiredJSCallback')
->setAttribute('data-error-callback', 'youErrorJSCallback')
->setAttribute('data-tabindex', 0);
2 Aug 6, 2022
12 Apr 25, 2022
214 Nov 21, 2022
1 Feb 7, 2022
1 May 27, 2022
14 Dec 11, 2022
3 Aug 19, 2022
9.6k Jan 1, 2023
8 Aug 12, 2022
13 Apr 14, 2022
10 Jul 10, 2022
4 Jan 3, 2022
14 Apr 14, 2022
52 Dec 21, 2022
4 Apr 20, 2022
2 Nov 10, 2022
4.9k Dec 27, 2022
4 Apr 20, 2022
1 Oct 14, 2021