oposs/silverstripe-hcaptcha

Protect your forms with hCaptcha

0.2.0 2025-06-06 12:42 UTC

Requires

• php: ^8.1
• ext-curl: *
• ext-json: *
• silverstripe/cms: ^5.0
• silverstripe/framework: ^5.0
• silverstripe/spamprotection: ^4.0

MIT

• Tobias Bossert

• captcha
• silverstripe
• spamprotection
• hcaptcha

README

Protect your forms with hCaptcha, a GDPR, CCPA, LGPD, PIPL and more compliant spam prodection (according their website)

Installation

Note: This version of the module is compatible with Silverstripe CMS 5.x. For Silverstripe 4.x compatibility, please use an earlier version/tag.

Make sure you met the following requirements beforehand:

• SilverStripe 5.x
• SilverStripe Spam Protection 4.x
• PHP 8.1+
• PHP CURL and JSON extensions

composer require oposs/silverstripe-hcaptcha

And set hCaptcha as your default spamprotector:

# app/_config/spamprotection.yml
SilverStripe\SpamProtection\Extension\FormSpamProtectionExtension:
  default_spam_protector: Oposs\hCaptcha\hCaptchaProtector

Configuration

In your app/_config/hcaptcha.yml

Oposs\hCaptcha\Forms\hCaptchaField:
  site_key: 'your_site_key'
  # Make sure to set the key starting with 0x.. in quotes
  secret_key: 'your_secret_key'
  # To configure options listed here https://docs.hcaptcha.com/configuration
  api_configuration:
    recaptchacompat: 'off'

For more configuration options check comments in hCaptchaField.php

Usage

In php:

use Oposs\hCaptcha\hCaptchaProtector\Forms

new hCaptchaField('SpamProtection', 'SpamProtection', null);

Or if you use Userforms:

Troubleshooting

Q: Users are redirected to the main page when the captcha is incorrect or not solved

A: This is most likely a redirecting problem, if your site is running behind a proxy have a look at the Director's alternate_base_url property (albeit heavily used, not document yet...)

Contributions are welcome :)