class Fields in Drupal 10

The basic 'fields' row plugin.

This displays fields one after another, giving options for inline or not.

Plugin annotation

@ViewsRow(
  id = "fields",
  title = @Translation("Fields"),
  help = @Translation("Displays the fields with an optional template."),
  theme = "views_view_fields",
  display_types = {"normal"}
)

Hierarchy

• class \Drupal\views\Plugin\views\row\Fields extends \Drupal\views\Plugin\views\row\RowPluginBase

2 files declare their use of Fields

StyleTest.php in core/modules/views/tests/src/Kernel/Plugin/StyleTest.php

ViewExecutableTest.php in core/modules/views/tests/src/Kernel/ViewExecutableTest.php

11 string references to 'Fields'

contextual.views.schema.yml in core/modules/contextual/config/schema/contextual.views.schema.yml

core/modules/contextual/config/schema/contextual.views.schema.yml

ContextualLinks::buildOptionsForm in core/modules/contextual/src/Plugin/views/field/ContextualLinks.php

drupal6.php in core/modules/migrate_drupal/tests/fixtures/drupal6.php

A database agnostic dump for testing purposes.

Links::buildOptionsForm in core/modules/views/src/Plugin/views/field/Links.php

TokenizeAreaPluginBase::tokenForm in core/modules/views/src/Plugin/views/area/TokenizeAreaPluginBase.php

Adds tokenization form elements.

... See full list

File

core/modules/views/src/Plugin/views/row/Fields.php, line 23

Namespace

Drupal\views\Plugin\views\row

class Fields extends RowPluginBase {

  /**
   * Does the row plugin support to add fields to its output.
   *
   * @var bool
   */
  protected $usesFields = TRUE;
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['inline'] = [
      'default' => [],
    ];
    $options['separator'] = [
      'default' => '',
    ];
    $options['hide_empty'] = [
      'default' => FALSE,
    ];
    $options['default_field_elements'] = [
      'default' => TRUE,
    ];
    return $options;
  }

  /**
   * Provide a form for setting options.
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $options = $this->displayHandler
      ->getFieldLabels();
    if (empty($this->options['inline'])) {
      $this->options['inline'] = [];
    }
    $form['default_field_elements'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Provide default field wrapper elements'),
      '#default_value' => $this->options['default_field_elements'],
      '#description' => $this
        ->t('If not checked, fields that are not configured to customize their HTML elements will get no wrappers at all for their field, label and field + label wrappers. You can use this to quickly reduce the amount of markup the view provides by default, at the cost of making it more difficult to apply CSS.'),
    ];
    $form['inline'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Inline fields'),
      '#options' => $options,
      '#default_value' => $this->options['inline'],
      '#description' => $this
        ->t('Inline fields will be displayed next to each other rather than one after another. Note that some fields will ignore this if they are block elements, particularly body fields and other formatted HTML.'),
      '#states' => [
        'visible' => [
          ':input[name="row_options[default_field_elements]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['separator'] = [
      '#title' => $this
        ->t('Separator'),
      '#type' => 'textfield',
      '#size' => 10,
      '#default_value' => $this->options['separator'] ?? '',
      '#description' => $this
        ->t('The separator may be placed between inline fields to keep them from squishing up next to each other. You can use HTML in this field.'),
      '#states' => [
        'visible' => [
          ':input[name="row_options[default_field_elements]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['hide_empty'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide empty fields'),
      '#default_value' => $this->options['hide_empty'],
      '#description' => $this
        ->t('Do not display fields, labels or markup for fields that are empty.'),
    ];
  }

  /**
   * Perform any necessary changes to the form values prior to storage.
   *
   * There is no need for this function to actually store the data.
   */
  public function submitOptionsForm(&$form, FormStateInterface $form_state) {
    $inline = $form_state
      ->getValue([
      'row_options',
      'inline',
    ]);
    $form_state
      ->setValue([
      'row_options',
      'inline',
    ], array_filter($inline));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Fields::$usesFields	protected	property	Does the row plugin support to add fields to its output.
Fields::buildOptionsForm	public	function	Provide a form for setting options.	1
Fields::defineOptions	protected	function		1
Fields::submitOptionsForm	public	function	Perform any necessary changes to the form values prior to storage.