README

Based on reCaptcha API 2.0.

Installation

The preferred way to install this extension is through composer.

• Either run

php composer.phar require --prefer-dist "ferrumfist/yii2-recaptcha-widget" "*"

or add

"ferrumfist/yii2-recaptcha-widget" : "*"

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' => [
        'name' => 'reCaptcha',
        'class' => 'ferrumfist\yii2\recaptcha\ReCaptcha',
        'siteKey' => 'your siteKey',
        'secret' => 'your secret key',
    ],
    ...

• Add ReCaptchaValidator in your model, for example:

public $reCaptcha;

public function rules()
{
  return [
      // ...
      [['reCaptcha'], \ferrumfist\yii2\recaptcha\ReCaptchaValidator::className(), 'secret' => 'your secret key', 'uncheckedMessage' => 'Please confirm that you are not a bot.']
  ];
}

or just

public function rules()
{
  return [
      // ...
      [[], \ferrumfist\yii2\recaptcha\ReCaptchaValidator::className(), 'secret' => 'your secret key']
  ];
}

or simply

public function rules()
{
  return [
      // ...
      [[], \ferrumfist\yii2\recaptcha\ReCaptchaValidator::className()]
  ];
}

Usage

For example:

<?= $form->field($model, 'reCaptcha')->widget(
    \ferrumfist\yii2\recaptcha\ReCaptcha::className(),
    ['siteKey' => 'your siteKey']
) ?>

or

<?= $form->field($model, 'reCaptcha')->widget(\ferrumfist\yii2\recaptcha\ReCaptcha::className()) ?>

or

<?= \ferrumfist\yii2\recaptcha\ReCaptcha::widget([
    'name' => 'reCaptcha',
    'siteKey' => 'your siteKey',
    'widgetOptions' => ['class' => 'col-sm-offset-3']
]) ?>

or simply

<?= \ferrumfist\yii2\recaptcha\ReCaptcha::widget(['name' => 'reCaptcha']) ?>

Resources

• Google reCAPTCHA