g
Frontend | Backend | Api

Forms\Models\Api\InputCaptcha

Entity for Google reCAPTCHA field. Based on mode it could be either "I am not a robot" checkbox or invisible badge.

Property Description Returns
required Always required bool
type Returns the type of the current element. string
mode Returns specified mode -- checkbox, invisible -- based on settings. Checkbox is used to render "I am not a robot" checkbox. Invisible -- for an invisible badge. string
siteKey Gets reCAPTCHA site key that is used for its rendering, usually in `data-sitekey` attribute. Returns different keys based on recaptcha input mode. This method is public because you need to render a site key on html. string
errors Gets all violations (error messages) related to the element's current submission array
errorMessage Gets error message for the field. If there are several errors for the element, all of them will be added to this message. string
errors Returns whether element has at least one error bool
name string
entity string
id int
help Gets help text for the element. It could be used as a tooltip or in HTML as a title attribute, e.g. ' '. string
editor string
text Text for the element that usually is used for element's label string
defaultValue string
placeholder string
regex string
position int
settings array
revision FormRevision
step Step
submissions Collection (ElementSubmission)
parent ElementGroup