Yii2 extension for Google reCAPTCHA
ReCAPTCHA lets you embed a CAPTCHA in your web pages in order to protect them against spam and other types of automated abuse., (*1)
Installation
Adding reCAPTCHA to your site consists of three steps:, (*2)
- Getting started
- Displaying the widget
- Verifying the user's response
The preferred way to install this extension is through composer., (*3)
Either run, (*4)
$ php composer.phar require richweber/yii2-recaptcha "dev-master"
or add, (*5)
"richweber/yii2-recaptcha": "dev-master"
to the require
section of your composer.json
file., (*6)
Usage
Component Configuration
'components' => [
...
'recaptcha' => [
'class' => 'richweber\recaptcha\ReCaptcha',
'siteKey' => 'https://www.google.com/recaptcha/admin',
'secretKey' => 'https://www.google.com/recaptcha/admin',
'errorMessage' => 'Are you robot?',
],
...
],
use richweber\recaptcha\Captcha;
'contact-form']); ?>
<?= $form->field($model, 'name') ?>
<?= $form->field($model, 'email') ?>
<?= $form->field($model, 'subject') ?>
<?= $form->field($model, 'body')->textArea(['rows' => 6]) ?>
<?= Captcha::widget() ?>
<div class="form-group">
<?= Html::submitButton('Submit', ['class' => 'btn btn-primary', 'name' => 'contact-button']) ?>
</div>
Verifying the user's response
public function actionContact()
{
$model = new ContactForm();
if (
$model->load(Yii::$app->request->post())
&& Yii::$app->recaptcha->verifyResponse(
$_SERVER['REMOTE_ADDR'],
Yii::$app->request->post('g-recaptcha-response'))
&& $model->contact(Yii::$app->params['adminEmail'])
) {
Yii::$app->session->setFlash('contactFormSubmitted');
return $this->refresh();
} else {
return $this->render('contact', [
'model' => $model,
]);
}
}
License
yii2-recaptcha is released under the BSD 3-Clause License. See the bundled LICENSE.md
for details., (*7)