public function SimpleRecaptchaWebformHandler::buildConfigurationForm in Simple Google reCAPTCHA 8

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form: An associative array containing the initial structure of the plugin form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides WebformHandlerBase::buildConfigurationForm

File

modules/simple_recaptcha_webform/src/Plugin/WebformHandler/SimpleRecaptchaWebformHandler.php, line 81

Class

SimpleRecaptchaWebformHandler

Webform submission handler plugin.

Namespace

Drupal\simple_recaptcha_webform\Plugin\WebformHandler

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form['recaptcha'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Handler settings'),
    '#open' => TRUE,
  ];
  $form['recaptcha']['recaptcha_type'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('reCAPTCHA type'),
    '#options' => [
      'v2' => $this
        ->t('reCAPTCHA v2 (checkbox)'),
      'v3' => $this
        ->t('reCAPTCHA v3 (invisible)'),
    ],
    '#default_value' => $this->configuration['recaptcha_type'],
  ];
  $form['recaptcha']['v3_score'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('desired reCAPTCHA score'),
    '#max' => 100,
    '#min' => 1,
    '#default_value' => $this->configuration['v3_score'],
    '#states' => [
      'visible' => [
        ':input[name="settings[recaptcha][recaptcha_type]"]' => [
          'value' => 'v3',
        ],
      ],
    ],
    '#description' => $this
      ->t('reCAPTCHA v3 returns a score (100 is very likely a good interaction, 0 is very likely a bot). Based on the score, you can decide when to block form submissions.'),
  ];
  $form['recaptcha']['v3_error_message'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Custom error message'),
    '#default_value' => $this->configuration['v3_error_message'],
    '#states' => [
      'visible' => [
        ':input[name="settings[recaptcha][recaptcha_type]"]' => [
          'value' => 'v3',
        ],
      ],
    ],
    '#description' => $this
      ->t('This error message will be shown when reCAPTCHA validation will fail.'),
  ];
  return parent::buildConfigurationForm($form, $form_state);
}