public function ImageFormatter::settingsForm in Drupal 10

Same name and namespace in other branches

8 core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter::settingsForm()
9 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 119

Class

ImageFormatter: Plugin implementation of the 'image' formatter.

Namespace

Drupal\image\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $element = parent::settingsForm($form, $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,
  ];
  $image_loading = $this
    ->getSetting('image_loading');
  $element['image_loading'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Image loading'),
    '#weight' => 10,
    '#description' => $this
      ->t('Lazy render images with native image loading attribute (<em>loading="lazy"</em>). This improves performance by allowing browsers to lazily load images.'),
  ];
  $loading_attribute_options = [
    'lazy' => $this
      ->t('Lazy (<em>loading="lazy"</em>)'),
    'eager' => $this
      ->t('Eager (<em>loading="eager"</em>)'),
  ];
  $element['image_loading']['attribute'] = [
    '#title' => $this
      ->t('Image loading attribute'),
    '#type' => 'radios',
    '#default_value' => $image_loading['attribute'],
    '#options' => $loading_attribute_options,
    '#description' => $this
      ->t('Select the loading attribute for images. <a href=":link">Learn more about the loading attribute for images.</a>', [
      ':link' => 'https://html.spec.whatwg.org/multipage/urls-and-fetching.html#lazy-loading-attributes',
    ]),
  ];
  $element['image_loading']['attribute']['lazy']['#description'] = $this
    ->t('Delays loading the image until that section of the page is visible in the browser. When in doubt, lazy loading is recommended.');
  $element['image_loading']['attribute']['eager']['#description'] = $this
    ->t('Force browsers to download an image as soon as possible. This is the browser default for legacy reasons. Only use this option when the image is always expected to render.');
  return $element;
}

You are here