Download the PHP package aryehraber/statamic-captcha without Composer
On this page you can find all versions of the php package aryehraber/statamic-captcha. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download aryehraber/statamic-captcha
More information about aryehraber/statamic-captcha
Files in aryehraber/statamic-captcha
Package statamic-captcha
Short Description Protect your Statamic forms using a Captcha service
License MIT
Homepage https://github.com/aryehraber/statamic-captcha
Informations about the package statamic-captcha
Captcha
Protect your Statamic forms using a Captcha service.
This addon allows you to protect your Statamic forms using any of the following services:
- Google reCAPTCHA v2 (v3 not supported)
- hCaptcha
- Cloudflare Turnstile
- ALTCHA
After the initial setup, all you need to do is add the {{ captcha }}
tag inside your forms, easy peasy!
Installation
Install the addon via composer:
Publish the config file:
Alternately, you can manually setup the config file by creating captcha.php
inside your project's config
directory:
Once the config file is in place, make sure to add your sitekey
& secret
from Recaptcha's Console, hCaptcha's Console, Cloudflare's Dashboard or Altcha's Docs and add the handles of the Statamic Forms you'd like to protect:
If you would like Captcha to verify ALL forms without having to specify each one in the forms
config array, you may use the all
option instead.
Note: this should replace the array and be set as a string.
Usage
This will automatically render the Captcha element on the page. After the form is submitted, the addon will temporarily halt the form from saving while the Captcha service verifies that the request checks out. If all is good, the form will save as normal, otherwise an error will be added to the {{ errors }}
object.
Invisible Captcha
Simply set invisible
to true
inside Captcha's config (Turnstile handles invisibility from Cloudflares's Dashboard, so no Captcha config changes are needed). To hide the sticky Recaptcha badge, make sure to also set hide_badge
to true
.
Note: using Invisible Captcha will require you to display links to the Captcha service's Terms underneath the form, to make this easier use {{ captcha:disclaimer }}
. This message can be customised using the disclaimer
option inside Captcha's config, however sensible defaults have been added that will automatically switch depending on the Captcha service you're using.
User Registration & Login
Captcha can also verify User Registration & User Login form requests, simply set user_registration
/ user_login
to true
inside Captcha's config and use the {{ captcha }}
tag as normal inside Statamic's {{ user:register_form }}
/ {{ user:login_form }}
tags.
Data Attributes
Some of the Captcha services offer additional features, such as light/dark mode and sizing options, via data attributes. These can simply be added to the Captcha tag and will be passed through to the client-side widget.
Translations
This package is localized to English and German. If you need translations in another language, you can create them yourself:
- Create the translations file in
resources/lang/vendor/statamic-captcha/{language}/messages.php
. - You can use the English translation file as a blueprint.
- You are welcome to share your translations here by submitting a PR.
If you want to change existing messages, you can publish and override them:
Advanced
Custom "Should Verify" Logic
You can provide additional custom logic to determine if verification should be attempted using a custom invokable class. This is useful to adjust Captcha's shouldVerify
check to include app-specific behaviour, for example: only enforcing Captcha for guest users and bypassing it for logged-in users.
To get started, create an invokable class within your app, and add it as the custom_should_verify
property in your config:
This invokable class must implement the \AryehRaber\Captcha\Contracts\CustomShouldVerify
interface, which enforces that an event param gets passed into the invoke method and subsequently returns an optional boolean. To stop Captcha's shouldVerify
method from getting called, the invoke method must return false
, otherwise returning true
(or null
) will continue Captcha's verification logic.
Note: this custom class is resolved via Laravel's container, meaning dependency injection is available via the constructor.