public function CommentWidget::formElement in Drupal 9

Same name and namespace in other branches

8 core/modules/comment/src/Plugin/Field/FieldWidget/CommentWidget.php \Drupal\comment\Plugin\Field\FieldWidget\CommentWidget::formElement()

Returns the form for a single field widget.

Field widget form elements should be based on the passed-in $element, which contains the base form element properties derived from the field configuration.

The BaseWidget methods will set the weight, field name and delta values for each form element. If there are multiple values for this field, the formElement() method will be called as many times as needed.

Other modules may alter the form element provided by this function using hook_field_widget_single_element_form_alter() or hook_field_widget_single_element_WIDGET_TYPE_form_alter().

The FAPI element callbacks (such as #process, #element_validate, #value_callback, etc.) used by the widget do not have access to the original $field_definition passed to the widget's constructor. Therefore, if any information is needed from that definition by those callbacks, the widget implementing this method, or a hook_field_widget[_WIDGET_TYPE]_form_alter() implementation, must extract the needed properties from the field definition and set them as ad-hoc $element['#custom'] properties, for later use by its element callbacks.

Parameters

\Drupal\Core\Field\FieldItemListInterface $items: Array of default values for this field.

int $delta: The order of this item in the array of sub-elements (0, 1, 2, etc.).

array $element: A form element array containing basic properties for the widget:

#field_parents: The 'parents' space for the field in the form. Most widgets can simply overlook this property. This identifies the location where the field values are placed within $form_state->getValues(), and is used to access processing information for the field through the getWidgetState() and setWidgetState() methods.
#title: The sanitized element label for the field, ready for output.
#description: The sanitized element description for the field, ready for output.
#required: A Boolean indicating whether the element value is required; for required multiple value fields, only the first widget's values are required.
#delta: The order of this item in the array of sub-elements; see $delta above.

array $form: The form structure where widgets are being attached to. This might be a full form structure, or a sub-element of a larger form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form elements for a single widget for this field.

Overrides WidgetInterface::formElement

File

core/modules/comment/src/Plugin/Field/FieldWidget/CommentWidget.php, line 27

Class

CommentWidget: Provides a default comment widget.

Namespace

Drupal\comment\Plugin\Field\FieldWidget

Code

public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
  $entity = $items
    ->getEntity();
  $element['status'] = [
    '#type' => 'radios',
    '#title' => t('Comments'),
    '#title_display' => 'invisible',
    '#default_value' => $items->status,
    '#options' => [
      CommentItemInterface::OPEN => t('Open'),
      CommentItemInterface::CLOSED => t('Closed'),
      CommentItemInterface::HIDDEN => t('Hidden'),
    ],
    CommentItemInterface::OPEN => [
      '#description' => t('Users with the "Post comments" permission can post comments.'),
    ],
    CommentItemInterface::CLOSED => [
      '#description' => t('Users cannot post comments, but existing comments will be displayed.'),
    ],
    CommentItemInterface::HIDDEN => [
      '#description' => t('Comments are hidden from view.'),
    ],
  ];

  // If the entity doesn't have any comments, the "hidden" option makes no
  // sense, so don't even bother presenting it to the user unless this is the
  // default value widget on the field settings form.
  if (!$this
    ->isDefaultValueWidget($form_state) && !$items->comment_count) {
    $element['status'][CommentItemInterface::HIDDEN]['#access'] = FALSE;

    // Also adjust the description of the "closed" option.
    $element['status'][CommentItemInterface::CLOSED]['#description'] = t('Users cannot post comments.');
  }

  // If the advanced settings tabs-set is available (normally rendered in the
  // second column on wide-resolutions), place the field as a details element
  // in this tab-set.
  if (isset($form['advanced'])) {

    // Get default value from the field.
    $field_default_values = $this->fieldDefinition
      ->getDefaultValue($entity);

    // Override widget title to be helpful for end users.
    $element['#title'] = $this
      ->t('Comment settings');
    $element += [
      '#type' => 'details',
      // Open the details when the selected value is different to the stored
      // default values for the field.
      '#open' => $items->status != $field_default_values[0]['status'],
      '#group' => 'advanced',
      '#attributes' => [
        'class' => [
          'comment-' . Html::getClass($entity
            ->getEntityTypeId()) . '-settings-form',
        ],
      ],
      '#attached' => [
        'library' => [
          'comment/drupal.comment',
        ],
      ],
    ];
  }
  return $element;
}

You are here