PHPackages                             bataboom/h-captcha - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. bataboom/h-captcha

ActiveLibrary[Authentication & Authorization](/categories/authentication)

bataboom/h-captcha
==================

hCAPTCHA For Laravel.

06PHP

Since Mar 27Pushed 1y agoCompare

[ Source](https://github.com/BataBoom/h-captcha)[ Packagist](https://packagist.org/packages/bataboom/h-captcha)[ RSS](/packages/bataboom-h-captcha/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

hCAPTCHA for Laravel
====================

[](#hcaptcha-for-laravel)

Inspirations: [anhskohbo/no-captcha](https://github.com/anhskohbo/no-captcha) package. [abanoubnassem/filament-grecaptcha-field](https://github.com/AbanoubNassem/filament-grecaptcha-field) package.

Installation
------------

[](#installation)

```
composer require bataboom/h-captcha:dev-master

```

Laravel 5 and above
-------------------

[](#laravel-5-and-above)

### Setup

[](#setup)

***NOTE*** This package supports the auto-discovery feature of Laravel 5.5 and above, So skip these `Setup` instructions if you're using Laravel 5.5 and above.

In `app/config/app.php` add the following :

1- The ServiceProvider to the providers array :

```
BataBoom\Captcha\HCaptchaServiceProvider::class,
```

2- The class alias to the aliases array :

```
'HCaptcha' => BataBoom\Captcha\Facades\HCaptcha::class,
```

3- Publish the config file

```
php artisan vendor:publish --provider="BataBoom\Captcha\HCaptchaServiceProvider"

```

### Configuration

[](#configuration)

Add `HCaptcha_SECRET` and `HCaptcha_SITEKEY` in **.env** file :

```
HCAPTCHA_SECRET=secret-key
HCAPTCHA_SITEKEY=site-key

```

(You can obtain them from [here](https://www.google.com/recaptcha/admin))

### Usage

[](#usage)

#### Init js source

[](#init-js-source)

With default options :

```
 {!! HCaptcha::renderJs() !!}
```

With [language support](https://developers.google.com/recaptcha/docs/language) or [onloadCallback](https://developers.google.com/recaptcha/docs/display#explicit_render) option :

```
 {!! HCaptcha::renderJs('fr', true, 'recaptchaCallback') !!}
```

#### Display reCAPTCHA

[](#display-recaptcha)

Default widget :

```
{!! HCaptcha::display() !!}
```

With [custom attributes](https://developers.google.com/recaptcha/docs/display#render_param) (theme, size, callback ...) :

```
{!! HCaptcha::display(['data-theme' => 'dark']) !!}

{!! HCaptcha::display(['data-theme' => 'dark', 'data-callback' => 'onSubmit', 'data-theme' => 'dark']) !!}
```

Invisible reCAPTCHA using a [submit button](https://developers.google.com/recaptcha/docs/invisible):

```
{!! HCaptcha::displaySubmit('my-form-id', 'submit now!', ['data-theme' => 'dark']) !!}
```

Notice that the id of the form is required in this method to let the autogenerated callback submit the form on a successful captcha verification.

#### Validation

[](#validation)

Add `'h-captcha-response' => 'required|captcha'` to rules array :

```
$validate = Validator::make(Input::all(), [
    'h-captcha-response' => 'required|captcha'
]);
```

##### Custom Validation Message

[](#custom-validation-message)

Add the following values to the `custom` array in the `validation` language file :

```
'custom' => [
    'h-captcha-response' => [
        'required' => 'Please verify that you are not a robot.',
        'captcha' => 'Captcha error! try again later or contact site admin.',
    ],
],
```

Then check for captcha errors in the `Form` :

```
@if ($errors->has('h-captcha-response'))

        {{ $errors->first('h-captcha-response') }}

@endif
```

### Testing

[](#testing)

When using the [Laravel Testing functionality](http://laravel.com/docs/5.5/testing), you will need to mock out the response for the captcha form element.

So for any form tests involving the captcha, you can do this by mocking the facade behavior:

```
// prevent validation error on captcha
HCaptcha::shouldReceive('verifyResponse')
    ->once()
    ->andReturn(true);

// provide hidden input for your 'required' validation
HCaptcha::shouldReceive('display')
    ->zeroOrMoreTimes()
    ->andReturn('');
```

You can then test the remainder of your form as normal.

When using HTTP tests you can add the `h-captcha-response` to the request body for the 'required' validation:

```
// prevent validation error on captcha
HCaptcha::shouldReceive('verifyResponse')
    ->once()
    ->andReturn(true);

// POST request, with request body including h-captcha-response
$response = $this->json('POST', '/register', [
    'h-captcha-response' => '1',
    'name' => 'John',
    'email' => 'john@example.com',
    'password' => '123456',
    'password_confirmation' => '123456',
]);
```

Without Laravel
---------------

[](#without-laravel)

Checkout example below:

```