Based on reCaptcha API 2.0., (*1)
Installation
The preferred way to install this extension is through composer., (*2)
composer require --prefer-dist "axelpal/yii2-recaptcha-widget" "^1.0"
or add, (*3)
"axelpal/yii2-recaptcha-widget" : "^1.0"
to the require
section of your application's composer.json
file., (*4)
-
Sign up for an reCAPTCHA API keys., (*5)
-
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., (*6)
'components' => [
'reCaptcha' => [
'name' => 'reCaptcha',
'class' => 'himiklab\yii2\recaptcha\ReCaptcha',
'siteKey' => 'your siteKey',
'secret' => 'your secret key',
],
...
- Add
ReCaptchaValidator
in your model, for example:
public $reCaptcha;
public function rules()
{
return [
// ...
[['reCaptcha'], \himiklab\yii2\recaptcha\ReCaptchaValidator::className(), 'secret' => 'your secret key', 'uncheckedMessage' => 'Please confirm that you are not a bot.']
];
}
or just, (*7)
public function rules()
{
return [
// ...
[[], \himiklab\yii2\recaptcha\ReCaptchaValidator::className(), 'secret' => 'your secret key']
];
}
or simply, (*8)
public function rules()
{
return [
// ...
[[], \himiklab\yii2\recaptcha\ReCaptchaValidator::className()]
];
}
Usage
For example:, (*9)
<?= $form->field($model, 'reCaptcha')->widget(
\himiklab\yii2\recaptcha\ReCaptcha::className(),
['siteKey' => 'your siteKey']
) ?>
or, (*10)
<?= \himiklab\yii2\recaptcha\ReCaptcha::widget([
'name' => 'reCaptcha',
'siteKey' => 'your siteKey',
'widgetOptions' => ['class' => 'col-sm-offset-3']
]) ?>
or, (*11)
<?= $form->field($model, 'reCaptcha')->widget(\himiklab\yii2\recaptcha\ReCaptcha::className()) ?>
or simply, (*12)
<?= \himiklab\yii2\recaptcha\ReCaptcha::widget(['name' => 'reCaptcha']) ?>
Resources