s4studio/yii2-recaptcha-widget

Yii2 Google reCAPTCHA v2 and v3 widget

2.2.0 2022-07-29 07:13 UTC

Requires

• yiisoft/yii2: ~2.0.11
• yiisoft/yii2-httpclient: *

Requires (Dev)

• phpunit/phpunit: ^4.8.34

MIT

• HimikLab
• s4studio

• recaptcha
• google
• captcha
• widget
• yii2

README

Based on Google reCaptcha API 2.0 and 3.0.

Urgent

Warning! Classes ReCaptcha and ReCaptchaValidator were removed. Original project provided by himiklab was dropped.

Installation

The preferred way to install this extension is through composer.

• Either run

php composer.phar require --prefer-dist "s4studio/yii2-recaptcha-widget" "dev-master"

or add

"s4studio/yii2-recaptcha-widget" : "dev-master"

to the require section of your application's composer.json file.

• Sign up for an reCAPTCHA API keys.

• Configure the component in your configuration file (web.php). The parameters siteKey and secret are optional. But if you leave them out you need to set them in every validation rule and every view where you want to use this widget. If a siteKey or secret is set in an individual view or validation rule that would overrule what is set in the config.

'components' => [
    'reCaptcha' => [
        'class' => 's4studio\recaptcha\ReCaptchaConfig',
        'siteKeyV2' => 'your siteKey v2',
        'secretV2' => 'your secret key v2',
        'siteKeyV3' => 'your siteKey v3',
        'secretV3' => 'your secret key v3',
    ],
    ...

or use DI container:

'container' => [
    'definitions' => [
        s4studio\recaptcha\ReCaptcha2::className() => function ($container, $params, $config) {
            return new s4studio\recaptcha\ReCaptcha2(
                'your siteKey v2',
                '', // default
                $config
            );
        },
        s4studio\recaptcha\ReCaptchaValidator2::className() => function ($container, $params, $config) {
            return new s4studio\recaptcha\ReCaptchaValidator2(
                'your secret key v2',
                '', // default
                null, // default
                null, // default
                $config
            );
        },
    ],
],

• Add ReCaptchaValidator2 or ReCaptchaValidator3 in your model, for example:

v2

public $reCaptcha;

public function rules()
{
  return [
      // ...
      [['reCaptcha'], \s4studio\recaptcha\ReCaptchaValidator2::className(),
        'secret' => 'your secret key', // unnecessary if reСaptcha is already configured
        'uncheckedMessage' => 'Please confirm that you are not a bot.'],
  ];
}

v3

public $reCaptcha;

public function rules()
{
  return [
      // ...
      [['reCaptcha'], \s4studio\recaptcha\ReCaptchaValidator3::className(),
        'secret' => 'your secret key', // unnecessary if reСaptcha is already configured
        'threshold' => 0.5,
        'action' => 'homepage',
      ],
  ];
}

Usage

For example:

v2

<?= $form->field($model, 'reCaptcha')->widget(
    \s4studio\recaptcha\ReCaptcha2::className(),
    [
        'siteKey' => 'your siteKey', // unnecessary is reCaptcha component was set up
    ]
) ?>

v3

<?= $form->field($model, 'reCaptcha')->widget(
    \s4studio\recaptcha\ReCaptcha3::className(),
    [
        'siteKey' => 'your siteKey', // unnecessary is reCaptcha component was set up
        'action' => 'homepage',
    ]
) ?>

or

v2

<?= \s4studio\recaptcha\ReCaptcha2::widget([
    'name' => 'reCaptcha',
    'siteKey' => 'your siteKey', // unnecessary is reCaptcha component was set up
    'widgetOptions' => ['class' => 'col-sm-offset-3'],
]) ?>

v3

<?= \s4studio\recaptcha\ReCaptcha3::widget([
    'name' => 'reCaptcha',
    'siteKey' => 'your siteKey', // unnecessary is reCaptcha component was set up
    'action' => 'homepage',
    'widgetOptions' => ['class' => 'col-sm-offset-3'],
]) ?>

• NOTE: Please disable ajax validation for ReCaptcha field!

Resources

• Google reCAPTCHA v2
• Google reCAPTCHA v3