Laravel ReCAPTCHA - v3

Simple Google reCAPTCHA package for Laravel 5

System requirements

PHP 7.1 or greater

Are you still using PHP 5.x or 7.0? Please go to V2

Installation

You can install the package via composer:

composer require biscolab/laravel-recaptcha:^3.0

Laravel 5.5 (or greater) uses package auto-discovery, so doesn't require you to manually add the Service Provider, but if you don't use auto-discovery ReCaptchaServiceProvider must be registered in config/app.php:

'providers' => [
    ...
    Biscolab\ReCaptcha\ReCaptchaServiceProvider::class,
];

You can use the facade for shorter code. Add ReCaptcha to your aliases:

'aliases' => [
    ...
    'ReCaptcha' => Biscolab\ReCaptcha\Facades\ReCaptcha::class,
];

Create config/recaptcha.php configuration file using:

php artisan vendor:publish --provider="Biscolab\ReCaptcha\ReCaptchaServiceProvider"

Configuration

Add your API Keys

Open .env file and set RECAPTCHA_SITE_KEY and RECAPTCHA_SECRET_KEY:

RECAPTCHA_SITE_KEY=YOUR_API_SITE_KEY
RECAPTCHA_SECRET_KEY=YOUR_API_SECRET_KEY

Open config/recaptcha.php configuration file and set version:

return [
    'api_site_key'      => env('RECAPTCHA_SITE_KEY', ''),
    'api_secret_key'    => env('RECAPTCHA_SECRET_KEY', ''),
    'version'           => 'v2' // supported: v2|invisible 
    'skip_ip'           => [] // array of IP addresses - String: dotted quad format e.g.: 127.0.0.1
];

For more invermation about Site Key and Secret Key please visit Google reCAPTCHA developer documentation Get more info about reCAPTCHA version at https://developers.google.com/recaptcha/docs/versions skip_ip is a list of IP addresses that, if recognized, disable the reCAPTCHA validation (return always true).

Have you updated?

If you are migrating from an older version add skip_ip array in recaptcha.php configuration file.

Customize error message

Before starting please add the validation message to resources/lang/[LANG]/validation.php file

return [
    ...
    'recaptcha' => 'Hey!!! :attribute is wrong!',
];

How to use

Embed in Blade

Insert htmlScriptTagJsApi($formId) helper before closing </head> tag You can also use ReCaptcha::htmlScriptTagJsApi($formId). $formId is required only if you are using ReCAPTCHA INVISIBLE

<!DOCTYPE html>
<html>
    <head>
        ...
        {!! htmlScriptTagJsApi(/* $formId - INVISIBLE version only */) !!}
        or
        {!! ReCaptcha::htmlScriptTagJsApi(/* $formId - INVISIBLE version only */) !!}
    </head>

If you are using ReCAPTCHA v2

After you have to insert htmlFormSnippet() helper inside the form where you want to use the field g-recaptcha-response You can also use ReCaptcha::htmlFormSnippet() .

<form>
    ...
    {!! htmlFormSnippet() !!}
    <input type="submit">
</form>

If you are using ReCAPTCHA INVISIBLE

After you have to insert htmlFormButton($buttonInnerHTML) helper inside the form where you want to use ReCAPTCHA. This function creates submit button therefore you don't have to insert or similar. You can also use ReCaptcha::htmlFormButton($buttonInnerHTML) . $buttonInnerHTML is what you want to write on the submit button

<form>
    ...
    {!! htmlFormButton(/* $buttonInnerHTML - Optional */) !!}
</form>

Verify submitted data

Add recaptcha to your rules

$v = Validator::make(request()->all(), [
    ...
    'g-recaptcha-response' => 'recaptcha',
]);

Print form errors

$errors = $v->errors();

Test

composer test

arcanedev-maroc / laravel-recaptcha