class CommentWidget
Same name in other branches
- 8.9.x core/modules/comment/src/Plugin/Field/FieldWidget/CommentWidget.php \Drupal\comment\Plugin\Field\FieldWidget\CommentWidget
- 10 core/modules/comment/src/Plugin/Field/FieldWidget/CommentWidget.php \Drupal\comment\Plugin\Field\FieldWidget\CommentWidget
- 11.x core/modules/comment/src/Plugin/Field/FieldWidget/CommentWidget.php \Drupal\comment\Plugin\Field\FieldWidget\CommentWidget
Provides a default comment widget.
Plugin annotation
@FieldWidget(
id = "comment_default",
label = @Translation("Comment"),
field_types = {
"comment"
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface
- class \Drupal\Core\Field\WidgetBase extends \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\WidgetInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\comment\Plugin\Field\FieldWidget\CommentWidget extends \Drupal\Core\Field\WidgetBase
- class \Drupal\Core\Field\WidgetBase extends \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\WidgetInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of CommentWidget
File
-
core/
modules/ comment/ src/ Plugin/ Field/ FieldWidget/ CommentWidget.php, line 22
Namespace
Drupal\comment\Plugin\Field\FieldWidgetView source
class CommentWidget extends WidgetBase {
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$entity = $items->getEntity();
$element['status'] = [
'#type' => 'radios',
'#title' => $this->t('Comments'),
'#title_display' => 'invisible',
'#default_value' => $items->status,
'#options' => [
CommentItemInterface::OPEN => $this->t('Open'),
CommentItemInterface::CLOSED => $this->t('Closed'),
CommentItemInterface::HIDDEN => $this->t('Hidden'),
],
CommentItemInterface::OPEN => [
'#description' => $this->t('Users with the "Post comments" permission can post comments.'),
],
CommentItemInterface::CLOSED => [
'#description' => $this->t('Users cannot post comments, but existing comments will be displayed.'),
],
CommentItemInterface::HIDDEN => [
'#description' => $this->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'] = $this->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;
}
/**
* {@inheritdoc}
*/
public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
// Add default values for statistics properties because we don't want to
// have them in form.
foreach ($values as &$value) {
$value += [
'cid' => 0,
'last_comment_timestamp' => 0,
'last_comment_name' => '',
'last_comment_uid' => 0,
'comment_count' => 0,
];
}
return $values;
}
}
Members
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.