Captcha is used together with CaptchaAction to provide CAPTCHA - a way
of preventing website spamming.
The image element rendered by Captcha will display a CAPTCHA image generated by
an action whose route is specified by [[captchaAction]]. This action must be an instance of CaptchaAction.
When the user clicks on the CAPTCHA image, it will cause the CAPTCHA image
to be refreshed with a new CAPTCHA.
You may use CaptchaValidator to validate the user input matches
the current CAPTCHA verification code.
The following example shows how to use this widget with a model attribute:
php
echo Captcha::widget([
'model' => $model,
'attribute' => 'captcha',
]);
The following example will use the name property instead:
php
echo Captcha::widget([
'name' => 'captcha',
]);
You can also use this widget in an [[\yii\widgets\ActiveForm|ActiveForm]] using the [[\yii\widgets\ActiveField::widget()|widget()]]
method, for example like this:
php
field($model, 'captcha')->widget(\yii\captcha\Captcha::classname(), [
configure additional widget properties here
]) ?>