Laravel Recaptcha V3

https://github.com/josiasmontag/laravel-recaptchav3
Admin
A lightweight Laravel package for backend validation of Google's Recaptcha V3, focusing on verifying...
Tokens:16,550
Snippets:130
Trust Score:8.6
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Facade usage example: Verify reCAPTCHA response

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3-service-provider.md

Shows how the singleton binding is consumed transparently via the facade. No explicit retrieval is needed because register() bound the singleton.

```php
use Lunaweb\RecaptchaV3\Facades\RecaptchaV3;

// Works because register() bound the singleton:
$score = RecaptchaV3::verify($request->get('g-recaptcha-response'), 'register');
```

--------------------------------

### Install package with Composer

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/README.md

Install the Laravel Recaptcha V3 package via Composer.

```bash
composer require josiasmontag/laravel-recaptchav3
```

--------------------------------

### Use RecaptchaV3 facade to get sitekey

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Uses the RecaptchaV3 facade to access the same singleton instance and retrieve the site key. The facade proxies onto the identical singleton instance.

```php
use Lunaweb\RecaptchaV3\Facades\RecaptchaV3;

// Facade proxies onto the identical singleton instance:
$sitekey = RecaptchaV3::sitekey();
```

--------------------------------

### Basic verification with score branching

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Example from the README showing how to verify a token with the 'register' action and branch on the returned score. Scores above 0.7 are fully trusted, above 0.3 require additional email verification, otherwise the request is aborted with a 400 status.

```php
use Lunaweb\RecaptchaV3\Facades\RecaptchaV3;

$token = $request->get('g-recaptcha-response');
$score = RecaptchaV3::verify($token, 'register');

if ($score > 0.7) {
    // fully trusted, proceed
} elseif ($score > 0.3) {
    // require additional email verification
} else {
    return abort(400, 'You are most likely a bot');
}
```

--------------------------------

### sitekey() usage with facade and data attribute

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Example of using the RecaptchaV3 facade to get the site key and use it in a data attribute for a custom widget.

```php
use Lunaweb\RecaptchaV3\Facades\RecaptchaV3;

$sitekey = RecaptchaV3::sitekey();
// used to set a data attribute for a custom widget integration, e.g.:
// <div class="g-recaptcha" data-sitekey="{{ $sitekey }}"></div>
```

--------------------------------

### Mock RecaptchaV3 facade for testing

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/README.md

Mock the RecaptchaV3 facade to make forms testable. This example sets up a mock that expects the verify method to be called once and returns 1.0.

```php
RecaptchaV3::shouldReceive('verify')
    ->once()
    ->andReturn(1.0);
```

--------------------------------

### sitekey() Blade usage example

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Example of using sitekey() in a Blade template to set a JavaScript variable for the site key.

```php
// Blade-style template usage
<script>window.SITE_KEY = "{{ RecaptchaV3::sitekey() }}";</script>
```

--------------------------------

### Initialize reCAPTCHA JavaScript

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/README.md

Load the reCAPTCHA v3 JavaScript on every page to get the most context about interactions. Add to your header or footer template.

```php
{!! RecaptchaV3::initJs() !!}
```

--------------------------------

### Get reCAPTCHA score

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/README.md

Get the score and take variable action based on it. The verify method takes the token and action name. The example shows branching on score thresholds.

```php
// Import the facade class
use Lunaweb\RecaptchaV3\Facades\RecaptchaV3;
//  RecaptchaV3::verify($token, $action)
$score = RecaptchaV3::verify($request->get('g-recaptcha-response'), 'register')
if($score > 0.7) {
    // go
} elseif($score > 0.3) {
    // require additional email verification
} else {
    return abort(400, 'You are most likely a bot');
}
```

--------------------------------

### Error handling for invalid tokens or action mismatches

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Example showing how to distinguish invalid tokens or action mismatches from low scores. If verify returns false, the captcha is treated as invalid and a 422 response is returned; otherwise, scores below 0.5 trigger a 400 bot response.

```php
use Lunaweb\RecaptchaV3\Facades\RecaptchaV3;

$token = $request->get('g-recaptcha-response');

// Submitting 'register' as the action: a token minted for another action
// fails even if Google says success=true.
$score = RecaptchaV3::verify($token, 'register');

if ($score === false) {
    // Google rejected the token, the action did not match, or no score was
    // returned — treat as invalid captcha.
    return abort(422, ['g-recaptcha-response' => ['Captcha validation failed']]);
}

if ($score < 0.5) {
    return abort(400, 'You are most likely a bot');
}
```

--------------------------------

### Add reCAPTCHA field to form

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/README.md

Create an invisible input field that gets filled with a reCAPTCHA token on load. The field method accepts an action name and an optional field name (default 'g-recaptcha-response').

```html
<form method="post" action="/register">
    {!! RecaptchaV3::field('register') !!}
    <input type="submit" value="Register"></input>
</form>
```

--------------------------------

### Instance vs. static equivalence for the facade

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/facade-recaptchav3.md

Demonstrates that the facade and the container-resolved singleton instance are equivalent. Both paths call the same verify method and return the same result because the facade resolves the same container binding.

```php
use Lunaweb\RecaptchaV3\RecaptchaV3;
use Lunaweb\RecaptchaV3\Facades\RecaptchaV3 as RecaptchaV3Facade;

// 1. Container-resolved singleton instance
$instance = app(RecaptchaV3::class);
$scoreA = $instance->verify($token, 'register');

// 2. Facade — resolves the same container binding
$scoreB = RecaptchaV3Facade::verify($token, 'register');
```

--------------------------------

### Query provided services during bootstrap debugging

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3-service-provider.md

Demonstrates how to query the services provided by the provider during bootstrap debugging. The provides() method returns an array with the RecaptchaV3 class.

```php
$provider = app(RecaptchaV3ServiceProvider::class);
$services = $provider->provides(); // [Lunaweb\RecaptchaV3\RecaptchaV3::class]
```

--------------------------------

### RecaptchaV3::initJs()

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/facade-recaptchav3.md

Proxies to the instance initJs method. Returns a script tag HTML string.

```APIDOC
## RecaptchaV3::initJs()

### Description
Proxies to the instance `initJs()` method. Returns a `<script>` tag HTML string.

### Method
Static call via facade

### Endpoint
`RecaptchaV3::initJs()`

### Parameters
None

### Return Type
`string` — `<script>` tag HTML

### Example
```php
{!! RecaptchaV3::initJs() !!}
```
```

--------------------------------

### Basic static facade usage for form rendering and verification

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/facade-recaptchav3.md

Shows basic static usage of the facade for form rendering and verification. Calls verify, sitekey, initJs, and field methods. The comments indicate where to place the initJs and field outputs in Blade templates.

```php
use Lunaweb\RecaptchaV3\Facades\RecaptchaV3;

$token = $request->get('g-recaptcha-response');

// verify($token, $action = null)
$score = RecaptchaV3::verify($token, 'register');

// sitekey()
$key = RecaptchaV3::sitekey();

// initJs() — header template: {!! RecaptchaV3::initJs() !!}
// field($action, $name) — form template: {!! RecaptchaV3::field('register') !!}
```

--------------------------------

### initJs()

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Returns an HTML script tag for loading the reCAPTCHA API with the configured locale and site key.

```APIDOC
## `initJs` method

### Description
Returns a raw HTML `<script>` element string pointing at `<origin>/api.js?hl=<locale>&render=<sitekey>`.

### Method
`initJs()`

### Parameters
None.

### Return type
`string` — a raw HTML `<script>` element string pointing at `<origin>/api.js?hl=<locale>&render=<sitekey>`. With the default origin this yields `https://www.google.com/recaptcha/api.js?hl=<locale>&render=<sitekey>`. The locale comes from config (`recaptchav3.locale`) or falls back to the application locale.

### Examples
Basic (README recommendation: load on every page for best context):

```php
// header or footer template
{!! RecaptchaV3::initJs() !!}
```

Explicit locale variant (locale from `RECAPTCHAV3_LOCALE` env var, e.g. `ar`):

```php
// yields e.g.
// <script src="https://www.google.com/recaptcha/api.js?hl=ar&render=6Lexample..."></script>
{!! RecaptchaV3::initJs() !!}
```
```

--------------------------------

### RecaptchaV3ServiceProvider class source

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3-service-provider.md

Full source of the service provider class. It extends Illuminate\Support\ServiceProvider and is used to bootstrap the package. The boot method publishes the config file when running in console, merges the package config, and extends the validator with the 'recaptchav3' rule. The register method binds the RecaptchaV3 class as a singleton, and the provides method returns the service class.

```php
class RecaptchaV3ServiceProvider extends ServiceProvider
{

    /**
     * Bootstrap the application services.
     *
     * @return void
     */
    public function boot()
    {
        if ($this->app->runningInConsole()) {
            $this->publishes([
                __DIR__.'/../config/recaptchav3.php' => config_path('recaptchav3.php'),
            ], 'config');
        }
        $this->mergeConfigFrom(__DIR__.'/../config/recaptchav3.php', 'recaptchav3');

        $this->app['validator']->extend('recaptchav3', function ($attribute, $value, $paramaters) {
            $action = $paramaters[0];
            $minScore = isset($paramaters[1]) ? (float)$paramaters[1] : 0.5;
            $score = RecaptchaV3Facade::verify($value, $action);
            return $score && $score >= $minScore;
        });

    }

    /**
     * Register the service provider.
     */
    public function register()
    {
        $this->app->singleton(RecaptchaV3::class);
    }
    /**
     * Get the services provided by the provider.
     *
     * @return array
     */
    public function provides()
    {
        return [RecaptchaV3::class];
    }

}
```

--------------------------------

### Publish config file

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/README.md

Optionally publish the package's config file using this Artisan command.

```bash
php artisan vendor:publish --provider="Lunaweb\RecaptchaV3\Providers\RecaptchaV3ServiceProvider"
```

--------------------------------

### Configuration file src/config/recaptchav3.php

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/configuration.md

The package's configuration file, merged into the application config under the key 'recaptchav3'. All four keys are strings, populated from environment variables with defaults. The 'origin' default is 'https://www.google.com/recaptcha', while 'sitekey', 'secret', and 'locale' default to empty strings.

```php
return [
    'origin' => env('RECAPTCHAV3_ORIGIN', 'https://www.google.com/recaptcha'),
    'sitekey' => env('RECAPTCHAV3_SITEKEY', ''),
    'secret' => env('RECAPTCHAV3_SECRET', ''),
    'locale' => env('RECAPTCHAV3_LOCALE', '')
];
```

--------------------------------

### sitekey() method signature

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

The public method signature for sitekey(), which returns the configured site key. It takes no parameters and returns a string.

```php
public function sitekey()
{
    return $this->sitekey;
}
```

--------------------------------

### Manually register RecaptchaV3ServiceProvider in application providers

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3-service-provider.md

Use this registration only if Composer auto-discovery is not used. Add the provider class to the application's providers array.

```php
use Lunaweb\RecaptchaV3\Providers\RecaptchaV3ServiceProvider;

// in the application's providers registration:
return [
    // ...existing providers...
    RecaptchaV3ServiceProvider::class,
];
```

--------------------------------

### initJs() method signature

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

The public method signature for initJs(), which returns a raw HTML script element string for loading the reCAPTCHA API.

```php
public function initJs()
{
    return '<script src="' . $this->origin . '/api.js?hl=' . $this->locale . '&render=' . $this->sitekey . '"></script>';
}
```

--------------------------------

### RecaptchaV3::sitekey()

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/facade-recaptchav3.md

Proxies to the instance sitekey method. Returns the site key as a string.

```APIDOC
## RecaptchaV3::sitekey()

### Description
Proxies to the instance `sitekey()` method. Returns the site key as a string.

### Method
Static call via facade

### Endpoint
`RecaptchaV3::sitekey()`

### Parameters
None

### Return Type
`string`

### Example
```php
$key = RecaptchaV3::sitekey();
```
```

--------------------------------

### RecaptchaV3 constructor

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Constructor for the RecaptchaV3 class. It reads configuration values from the 'recaptchav3' key, applies defaults for 'origin' and 'locale', and stores the HTTP client and request. The constructor does not throw exceptions.

```php
public function __construct(Repository $config, Client $client, Request $request, Application $app)
{
    $this->secret = $config['recaptchav3']['secret'];
    $this->sitekey = $config['recaptchav3']['sitekey'];
    $this->origin = $config['recaptchav3']['origin'] ?? 'https://www.google.com/recaptcha';
    $this->locale = $config['recaptchav3']['locale'] ?? $app->getLocale();
    $this->http = $client;
    $this->request = $request;
}
```

--------------------------------

### initJs() basic usage in header or footer

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Basic usage of initJs() in a Blade template, as recommended by the README, to load the reCAPTCHA script on every page.

```php
// header or footer template
{!! RecaptchaV3::initJs() !!}
```

--------------------------------

### Provides method: Declare provided services

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3-service-provider.md

Declares the service provider's contract by returning an array containing the RecaptchaV3 class. This is used by the framework to discover the provider's services.

```php
public function provides()
{
    return [RecaptchaV3::class];
}
```

--------------------------------

### Register method: Bind RecaptchaV3 as singleton

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3-service-provider.md

Registers the RecaptchaV3 class as a singleton in the application container. This ensures constructor dependencies are resolved once per request lifecycle, enabling the facade to find a live instance.

```php
public function register()
{
    $this->app->singleton(RecaptchaV3::class);
}
```

--------------------------------

### Facade class definition with getFacadeAccessor

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/facade-recaptchav3.md

Defines the facade class that extends Illuminate\Support\Facades\Facade. The getFacadeAccessor method returns the class object of Lunaweb\RecaptchaV3\RecaptchaV3, which is the container binding that static calls are forwarded to.

```php
class RecaptchaV3 extends Facade
{
    /**
     * Get the registered name of the component.
     *
     * @return string
     */
    protected static function getFacadeAccessor()
    {
        return RecaptchaV3Instance::class;
    }
}
```

--------------------------------

### initJs() explicit locale variant

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Usage of initJs() with an explicit locale from the RECAPTCHAV3_LOCALE environment variable, showing the resulting script tag.

```php
// yields e.g.
// <script src="https://www.google.com/recaptcha/api.js?hl=ar&render=6Lexample..."></script>
{!! RecaptchaV3::initJs() !!}
```

--------------------------------

### Runtime override of recaptchav3 config in tests/TestCase.php

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/configuration.md

Demonstrates runtime overrides of the config values through the container's config repository, as shown in the package's test suite. Values set here take effect because the config is read at construction time.

```php
$app['config']->set('recaptchav3.sitekey', 'some_sitekey');
$app['config']->set('recaptchav3.secret', 'some_secret');
```

--------------------------------

### verify method source code

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

The complete implementation of the verify method from src/RecaptchaV3.php. It sends a POST request to Google's siteverify endpoint, checks the success flag strictly, optionally validates the action with loose equality, and returns the score or false.

```php
public function verify($token, $action = null)
{

    $response = $this->http->request('POST', $this->origin . '/api/siteverify', [
        'form_params' => [
            'secret'   => $this->secret,
            'response' => $token,
            'remoteip' => $this->request->getClientIp(),
        ],
    ]);


    $body = json_decode($response->getBody(), true);

    if (!isset($body['success']) || $body['success'] !== true) {
        return false;
    }

    if ($action && (!isset($body['action']) || $action != $body['action'])) {
        return false;
    }


    return isset($body['score']) ? $body['score'] : false;

}
```

--------------------------------

### RecaptchaV3::verify($token, $action = null)

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/facade-recaptchav3.md

Proxies to the instance verify method. Returns a float score or false.

```APIDOC
## RecaptchaV3::verify($token, $action = null)

### Description
Proxies to the instance `verify($token, $action = null)` method. Returns a float score or `false`.

### Method
Static call via facade

### Endpoint
`RecaptchaV3::verify($token, $action = null)`

### Parameters
- **$token** (string) - Required - The reCAPTCHA response token.
- **$action** (string|null) - Optional - The expected action name.

### Return Type
`mixed` — `float` score or `false`

### Example
```php
$score = RecaptchaV3::verify($token, 'register');
```
```

--------------------------------

### Set environment variables for reCAPTCHA keys

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/README.md

Add these environment variables to your .env file. Obtain the values from the Google reCAPTCHA admin console.

```env
RECAPTCHAV3_SITEKEY=sitekey
RECAPTCHAV3_SECRET=secret
```

--------------------------------

### getFacadeAccessor method implementation

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/facade-recaptchav3.md

The protected static method that returns the class object of the underlying RecaptchaV3 instance. This is the contract that allows static calls on the facade to be resolved by the base Facade class against the container binding.

```php
protected static function getFacadeAccessor()
{
    return RecaptchaV3Instance::class;
}
```

--------------------------------

### sitekey()

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Returns the configured reCAPTCHA site key as a string. Useful for embedding the site key in custom widget integrations.

```APIDOC
## `sitekey` method

### Description
Returns the configured reCAPTCHA site key.

### Method
`sitekey()`

### Parameters
None.

### Return type
`string` — the configured site key (`recaptchav3.sitekey` / `RECAPTCHAV3_SITEKEY`). May be an empty string `''` if not configured (config default).

### Examples
```php
// Blade-style template usage
<script>window.SITE_KEY = "{{ RecaptchaV3::sitekey() }}";</script>
```

```php
use Lunaweb\RecaptchaV3\Facades\RecaptchaV3;

$sitekey = RecaptchaV3::sitekey();
// used to set a data attribute for a custom widget integration, e.g.:
// <div class="g-recaptcha" data-sitekey="{{ $sitekey }}"></div>
```
```

--------------------------------

### Resolve RecaptchaV3 via container and verify

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Resolves the RecaptchaV3 instance from the Laravel container and calls the verify method with a token and action. The instance is a singleton registered by the service provider.

```php
use Lunaweb\RecaptchaV3\RecaptchaV3;

// Resolved via the container (singleton registered by the service provider):
$recaptcha = app(RecaptchaV3::class);

$score = $recaptcha->verify($token, 'register');
```

--------------------------------

### verify($token, $action = null)

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Verifies a reCAPTCHA v3 response token with Google's siteverify API. Returns a score between 0.0 and 1.0 on success, or false if verification fails, the action does not match, or no score is returned.

```APIDOC
## verify($token, $action = null)

### Description
Verifies a reCAPTCHA v3 response token by sending it to Google's siteverify endpoint. Returns the score (float/int) if the token is valid and the optional action matches, otherwise returns false.

### Method
POST (to Google's siteverify API)

### Endpoint
`{origin}/api/siteverify` (origin is typically `https://www.google.com`)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- `secret` (string) - Required - The secret key for the reCAPTCHA v3 site.
- `response` (string) - Required - The reCAPTCHA v3 response token from the client.
- `remoteip` (string) - Required - The client's IP address.

### Request Example
```json
{
  "secret": "your-secret-key",
  "response": "token-from-client",
  "remoteip": "127.0.0.1"
}
```

### Response
#### Success Response (200)
- `success` (boolean) - Whether the token is valid.
- `action` (string) - The action name associated with the token.
- `score` (number) - The score between 0.0 and 1.0.

#### Response Example
```json
{
  "success": true,
  "action": "register",
  "score": 0.9
}
```

### Error Handling
- If `success` is not true, returns `false`.
- If `$action` is provided and does not match the response `action`, returns `false`.
- If no `score` is present, returns `false`.
- HTTP transport errors propagate to the caller as Guzzle exceptions.

### Notes
- The comparison `$body['success'] !== true` is strict; a truthy non-true value like `1` fails.
- The action comparison uses loose equality (`!=`).
- The method does not catch exceptions; Guzzle exceptions propagate.

### Examples
Basic verification:
```php
use Lunaweb\RecaptchaV3\Facades\RecaptchaV3;

$token = $request->get('g-recaptcha-response');
$score = RecaptchaV3::verify($token, 'register');

if ($score > 0.7) {
    // fully trusted, proceed
} elseif ($score > 0.3) {
    // require additional email verification
} else {
    return abort(400, 'You are most likely a bot');
}
```

Error handling:
```php
use Lunaweb\RecaptchaV3\Facades\RecaptchaV3;

$token = $request->get('g-recaptcha-response');
$score = RecaptchaV3::verify($token, 'register');

if ($score === false) {
    return abort(422, ['g-recaptcha-response' => ['Captcha validation failed']]);
}

if ($score < 0.5) {
    return abort(400, 'You are most likely a bot');
}
```
```

--------------------------------

### Validator rule closure registered in RecaptchaV3ServiceProvider

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3-validator-rule.md

The exact closure registered by the service provider's boot method. It reads the action and optional minScore parameters, verifies the token via the facade, and returns true only if the score is truthy and at least the minimum.

```php
$this->app['validator']->extend('recaptchav3', function ($attribute, $value, $paramaters) {
    $action = $paramaters[0];
    $minScore = isset($paramaters[1]) ? (float)$paramaters[1] : 0.5;
    $score = RecaptchaV3Facade::verify($value, $action);
    return $score && $score >= $minScore;
});
```

--------------------------------

### Basic recaptchav3 rule usage with default minScore

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3-validator-rule.md

Basic usage from the README. Applies the rule to the default g-recaptcha-response attribute with the action 'register' and the default minimum score of 0.5.

```php
$validate = Validator::make(Input::all(), [
    'g-recaptcha-response' => 'required|recaptchav3:register',
]);
if ($validate->fails()) {
    return $validate->getErrors();
}
```

--------------------------------

### field($action, $name = 'g-recaptcha-response')

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Generates HTML containing a hidden input field and an inline script that calls grecaptcha.execute() to obtain a token for the given action. The token is stored in the hidden input's value.

```APIDOC
## `field` method

### Description
Generates HTML for a hidden input and an inline script that executes reCAPTCHA v3 and stores the token in the input's value.

### Method
`field`

### Signature
```php
public function field($action, $name = 'g-recaptcha-response')
```

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `$action` | `mixed` (expected `string`) | yes | — | Action string embedded into the emitted JavaScript (`grecaptcha.execute(sitekey, {action: '...'})`); must match the action passed to `verify()`/the validator rule |
| `$name` | `mixed` (expected `string`) | no | `'g-recaptcha-response'` | `name` attribute of the hidden input; also referenced by the validator rule attribute |

### Return type
`string` — HTML: one hidden `<input type="hidden" name="..." id="...">` element plus an inline `<script>` block that calls `grecaptcha.ready(...)` / `grecaptcha.execute(...)` and stores the resolved token into the input's `.value`. The input `id` is generated with Illuminate's `uniqid($name . '-', false)`.

### Examples

Basic (README):

```html
<form method="post" action="/register">
    {!! RecaptchaV3::field('register') !!}
    <input type="submit" value="Register"></input>
</form>
```

Custom field name, matched against the validation rule:

```html
<form method="post" action="/login">
    {!! RecaptchaV3::field('login', 'captcha_token') !!}
    <input type="submit" value="Login"></input>
</form>
```

```php
// Controller-side rules must reference the same field name:
$validate = Validator::make(Input::all(), [
    'captcha_token' => 'required|recaptchav3:login,0.3',
]);
```

**Caveat**: the default validation rule key `g-recaptcha-response` (and its custom error message key) only applies when `$name` is left at its default; a custom `$name` must be mirrored in the rules array.
```

--------------------------------

### Set reCAPTCHA locale

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/README.md

Optionally specify a locale for reCAPTCHA by adding this environment variable. By default, the package follows the application locale defined in config/app.php.

```env
RECAPTCHAV3_LOCALE=ar
```

--------------------------------

### RecaptchaV3::field($action, $name = 'g-recaptcha-response')

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/facade-recaptchav3.md

Proxies to the instance field method. Returns hidden input and script HTML.

```APIDOC
## RecaptchaV3::field($action, $name = 'g-recaptcha-response')

### Description
Proxies to the instance `field($action, $name = 'g-recaptcha-response')` method. Returns hidden input and script HTML.

### Method
Static call via facade

### Endpoint
`RecaptchaV3::field($action, $name = 'g-recaptcha-response')`

### Parameters
- **$action** (string) - Required - The action name.
- **$name** (string) - Optional - The name of the hidden input field. Defaults to `'g-recaptcha-response'`.

### Return Type
`string` — hidden input + script HTML

### Example
```php
{!! RecaptchaV3::field('register') !!}
```
```

--------------------------------

### field method signature

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

The `field` method signature from `src/RecaptchaV3.php` lines 117–129. It accepts an action string and an optional field name, returning HTML with a hidden input and inline script that calls `grecaptcha.execute` and stores the token.

```php
public function field($action, $name = 'g-recaptcha-response')
{
    $fieldId = uniqid($name . '-', false);
    $html = '<input type="hidden" name="' . $name . '" id="' . $fieldId . '">';
    $html .= "<script>
  grecaptcha.ready(function() {
      grecaptcha.execute('" . $this->sitekey . "', {action: '" . $action . "'}).then(function(token) {
         document.getElementById('" . $fieldId . "').value = token;
      });
  });
  </script>";
    return $html;
}
```

--------------------------------

### recaptchav3:<action>[,<minScore>]

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3-validator-rule.md

Validation rule to require a reCAPTCHA v3 token with a minimum score. The rule takes an action parameter and an optional minimum score, defaulting to 0.5.

```APIDOC
## recaptchav3:<action>[,<minScore>]

### Description
A validation rule that requires a reCAPTCHA v3 token with a minimum score. The rule verifies the token with Google and checks that the returned score is at least the specified minimum.

### Method
Validation Rule

### Endpoint
N/A (Laravel Validator rule)

### Parameters
#### Rule Parameters
- **action** (string) - Required - The action string the token was minted for; must equal the action passed to `RecaptchaV3::field($action, ...)`.
- **minScore** (float) - Optional - Minimum accepted score; compared with `>=`. Defaults to `0.5`.

#### Attribute Value
- **value** (string) - Required - The reCAPTCHA token (e.g., `g-recaptcha-response`).

### Request Example
```php
$validate = Validator::make(Input::all(), [
    'g-recaptcha-response' => 'required|recaptchav3:register',
]);
if ($validate->fails()) {
    return $validate->getErrors();
}
```

### Response
#### Success Response
- Returns `true` if the verification score is truthy and `score >= minScore`.
- Returns `false` otherwise, causing validation failure.

#### Response Example
N/A (returns boolean)

### Error Handling
No custom exceptions are thrown. Failed verification returns `false`, which the validator reports via standard `fails()`/`passes()` flow.
```

--------------------------------

### recaptchav3 rule with explicit minScore 0.3

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3-validator-rule.md

Explicit minimum score of 0.3, which accepts lower-scored human traffic. The comment shows the equivalent verification logic.

```php
$validate = Validator::make(Input::all(), [
    'g-recaptcha-response' => 'required|recaptchav3:register,0.3',
]);

// equivalent to:
//   $score = RecaptchaV3::verify($token, 'register');
//   $passes = ($score !== false) && ($score >= 0.3);
```

--------------------------------

### recaptchav3 rule with custom field name

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3-validator-rule.md

Combines the rule with a custom field name produced by RecaptchaV3::field('login', 'captcha_token'). The attribute must match the custom field name.

```php
$validate = Validator::make(Input::all(), [
    'captcha_token' => 'required|recaptchav3:login,0.3',
]);
```

--------------------------------

### Custom field name in a form

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

Usage with a custom field name `captcha_token` in the form. The validation rule must reference the same field name.

```html
<form method="post" action="/login">
    {!! RecaptchaV3::field('login', 'captcha_token') !!}
    <input type="submit" value="Login"></input>
</form>
```

--------------------------------

### Custom validation error message for recaptchav3

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3-validator-rule.md

Adds a keyed custom validation error message for the recaptchav3 rule on the g-recaptcha-response attribute in the validation language file.

```php
'custom' => [
    'g-recaptcha-response' => [
        'recaptchav3' => 'Captcha error message',
    ],
],
```

--------------------------------

### Validate reCAPTCHA response

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/README.md

Add the 'recaptchav3' validator to the rules array. The rule accepts the action name and the minimum required score (defaults to 0.5).

```php
$validate = Validator::make(Input::all(), [
	'g-recaptcha-response' => 'required|recaptchav3:register,0.5'
]);
```

--------------------------------

### Controller-side validation rule for custom field name

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/_autodocs/api-reference/recaptchav3.md

The validation rule in the controller must use the same custom field name `captcha_token` and the action `login` with a minimum score of 0.3. This is required when using a custom `$name`.

```php
// Controller-side rules must reference the same field name:
$validate = Validator::make(Input::all(), [
    'captcha_token' => 'required|recaptchav3:login,0.3',
]);
```

--------------------------------

### Hide reCAPTCHA badge

Source: https://github.com/josiasmontag/laravel-recaptchav3/blob/master/README.md

Hide the reCAPTCHA badge by adding this CSS rule to your stylesheet.

```css
.grecaptcha-badge { visibility: hidden !important; }
```
Tokens:
Raw