This package adds a validation rule and controller trait for easier integration with Google Recaptcha
Install this package through Composer.
composer require origami/captcha
This package is designed to work with Laravel >= 10 currently. If you require 5.8 support, use version 1. If you require 6-7 support use version 2.
-
Signup for a Google Recaptcha account at https://www.google.com/recaptcha/admin
-
You should add a recatpcha section to your
config/services.phpfile:
'recaptcha' => [
'key' => env('RECAPTCHA_KEY'),
'secret' => env('RECAPTCHA_SECRET'),
],- Update your
.envfile with the key and secret:
RECAPTCHA_KEY=
RECAPTCHA_SECRET=
- Add a language line to your validation file(s), e.g.
resources/lang/en/validation.php
'recaptcha' => 'The reCAPTCHA check was invalid',
$validator = Validator::make($request->all(), [
'recaptcha' => [new Origami\Captcha\Rules\Recaptcha],
]);(Assuming your Controller has the ValidatesRequests trait)
class Contact extends Controller
{
public function store(Request $request)
{
$this->validate($request, [
'recatpcha' => [new Origami\Captcha\Rules\Recaptcha]
]);
}
}If you have multiple Recaptcha secrets (e.g. for different versions), you can customise in the rule params. Otherwise it will default to config('services.recaptcha.secret')
class Contact extends Controller
{
public function store(Request $request)
{
$this->validate($request, [
'recatpcha' => [new Origami\Captcha\Rules\Recaptcha(secret: '123')]
]);
}
}use Origami\Captcha\ValidatesCaptcha;
class Contact extends Controller
{
use ValidatesCaptcha;
public function store(Request $request)
{
$this->validateRecaptcha($request);
// The above will throw a ValidationException when the recaptcha fails.
}
}This packages registers two Blade helpers:
@recaptchaField is the equivalent of:
<div class="g-recaptcha" data-sitekey="{{ config('services.recaptcha.key') }}"></div>
@recaptchaScript is the equivalent of:
<script src="https://www.google.com/recaptcha/api.js"></script>
Version 3 was created to add Laravel 11.x support and drop support for Laravel versions before 10.x. This is a breaking change as the package now relies on Rule Objects.
// Before
$validator = Validator::make($request->all(), [
'recaptcha' => 'recaptcha',
]);
// After
$validator = Validator::make($request->all(), [
'recaptcha' => [new Origami\Captcha\Rules\Recaptcha],
]);The ValidatesCaptcha trait validateReCaptcha method has been renamed validateRecaptcha