public function ImageFormatter::settingsForm in Drupal 9
Same name and namespace in other branches
- 8 core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter::settingsForm()
Returns a form to configure settings for the formatter.
Invoked from \Drupal\field_ui\Form\EntityDisplayFormBase to allow administrators to configure the formatter. The field_ui module takes care of handling submitted form values.
Parameters
array $form: The form where the settings form is being included in.
\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.
Return value
array The form elements for the formatter settings.
Overrides FormatterBase::settingsForm
2 calls to ImageFormatter::settingsForm()
- ImageUrlFormatter::settingsForm in core/
modules/ image/ src/ Plugin/ Field/ FieldFormatter/ ImageUrlFormatter.php - Returns a form to configure settings for the formatter.
- MediaThumbnailFormatter::settingsForm in core/
modules/ media/ src/ Plugin/ Field/ FieldFormatter/ MediaThumbnailFormatter.php - Returns a form to configure settings for the formatter.
2 methods override ImageFormatter::settingsForm()
- ImageUrlFormatter::settingsForm in core/
modules/ image/ src/ Plugin/ Field/ FieldFormatter/ ImageUrlFormatter.php - Returns a form to configure settings for the formatter.
- MediaThumbnailFormatter::settingsForm in core/
modules/ media/ src/ Plugin/ Field/ FieldFormatter/ MediaThumbnailFormatter.php - Returns a form to configure settings for the formatter.
File
- core/
modules/ image/ src/ Plugin/ Field/ FieldFormatter/ ImageFormatter.php, line 120
Class
- ImageFormatter
- Plugin implementation of the 'image' formatter.
Namespace
Drupal\image\Plugin\Field\FieldFormatterCode
public function settingsForm(array $form, FormStateInterface $form_state) {
$image_styles = image_style_options(FALSE);
$description_link = Link::fromTextAndUrl($this
->t('Configure Image Styles'), Url::fromRoute('entity.image_style.collection'));
$element['image_style'] = [
'#title' => t('Image style'),
'#type' => 'select',
'#default_value' => $this
->getSetting('image_style'),
'#empty_option' => t('None (original image)'),
'#options' => $image_styles,
'#description' => $description_link
->toRenderable() + [
'#access' => $this->currentUser
->hasPermission('administer image styles'),
],
];
$link_types = [
'content' => t('Content'),
'file' => t('File'),
];
$element['image_link'] = [
'#title' => t('Link image to'),
'#type' => 'select',
'#default_value' => $this
->getSetting('image_link'),
'#empty_option' => t('Nothing'),
'#options' => $link_types,
];
return $element;
}