public function UserRole::buildConfigurationForm in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/user/src/Plugin/Condition/UserRole.php \Drupal\user\Plugin\Condition\UserRole::buildConfigurationForm()
2. 10 core/modules/user/src/Plugin/Condition/UserRole.php \Drupal\user\Plugin\Condition\UserRole::buildConfigurationForm()

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 ConditionPluginBase::buildConfigurationForm

File

core/modules/user/src/Plugin/Condition/UserRole.php, line 24

Class

UserRole

Provides a 'User Role' condition.

Namespace

Drupal\user\Plugin\Condition

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form['roles'] = [
    '#type' => 'checkboxes',
    '#title' => $this
      ->t('When the user has the following roles'),
    '#default_value' => $this->configuration['roles'],
    '#options' => array_map('\\Drupal\\Component\\Utility\\Html::escape', user_role_names()),
    '#description' => $this
      ->t('If you select no roles, the condition will evaluate to TRUE for all users.'),
  ];
  return parent::buildConfigurationForm($form, $form_state);
}