README

Simple Laravel package for working with Google reCAPTCHA v3

Getting Started

Installation

1) Run command

composer require brandstudio/recaptcha

Or edit composer.json manually

"brandstudio/recaptcha": "^1.0@dev"

2) Publish the config file (optional)

php artisan vendor:publish --provider="BrandStudio\Recaptcha\RecaptchaServiceProvider" --tag=config

Configuration

brandstudio/recaptcha.php file

    /**
     * Enable/Disable reCAPTCHA
     */
    'enabled'           => env('BS_RECAPTCHA_ENABLED', true),

    /**
     * Middleware alias
     */
    'middleware_name'   => 'recaptcha',

    /**
     * Frontend integration
     */
    'url'               => 'https://www.google.com/recaptcha/api.js?render=',

    /**
     * Your sitekey
     */
    'public_key'        => env('BS_RECAPTCHA_PUBLIC', ''),

    /**
     * Response verification
     */
    'verification_url'  => 'https://www.google.com/recaptcha/api/siteverify',

    /**
     * Your secret key
     */
    'private_key'       => env('BS_RECAPTCHA_PRIVATE', ''),

Usage

In your .blade file

@include('brandstudio::recaptcha.scripts')
/// Or
@include('brandstudio::recaptcha.scripts', ['recaptcha_action' => 'your-action-name'])

See Google reCAPTCHA actions for details.

In controller

public function __construct()
{
    ...
    $this->middleware('recaptcha');
    ...
}

public function __construct()
{
    ...
    $this->middleware(config('backpack.recaptcha.middleware_name'));
    ...
}

In routes

Route::method('/url', 'Controller@function')->middleware('recaptcha');

Route::middleware([..., 'recaptcha'])->group(function() {
    ...
    Route::method('/url', 'Controller@function');
    ...
);

Hide Google reCAPTCHA badge

In CSS

.grecaptcha-badge {
    display: none;
}

You are allowed to hide the badge as long as you include the reCAPTCHA branding visibly in the user flow. Please include the following text:

<small>
    This site is protected by reCAPTCHA and the Google 
    <a href="https://policies.google.com/privacy">Privacy Policy</a> and
    <a href="https://policies.google.com/terms">Terms of Service</a> apply.
</small>

License

This project is licensed under the MIT License - see the LICENSE.md file for details

brandstudio / recaptcha

Maintainers

Details