public function BaseFieldDefinition::getDisplayOptions in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Field/BaseFieldDefinition.php \Drupal\Core\Field\BaseFieldDefinition::getDisplayOptions()
2. 9 core/lib/Drupal/Core/Field/BaseFieldDefinition.php \Drupal\Core\Field\BaseFieldDefinition::getDisplayOptions()

Returns the default display options for the field.

If the field's display is configurable, the returned display options act as default values and may be overridden via the respective entity display. Otherwise, the display options will be applied to entity displays as is.

Parameters

string $display_context: The display context. Either 'view' or 'form'.

Return value

array|null The array of display options for the field, or NULL if the field is not displayed. The following key/value pairs may be present:

• label: (string) Position of the field label. The default 'field' theme implementation supports the values 'inline', 'above' and 'hidden'. Defaults to 'above'. Only applies to 'view' context.
• region: (string) The region the field is in, or 'hidden'. If not specified, the default region will be used.
• type: (string) The plugin (widget or formatter depending on $display_context) to use. If not specified or if the requested plugin is unknown, the 'default_widget' / 'default_formatter' for the field type will be used. Previously 'hidden' was a valid value, it is now deprecated in favor of specifying 'region' => 'hidden'.
• settings: (array) Settings for the plugin specified above. The default settings for the plugin will be used for settings left unspecified.
• third_party_settings: (array) Settings provided by other extensions through hook_field_formatter_third_party_settings_form().
• weight: (float) The weight of the element. Not needed if 'type' is 'hidden'.

The defaults of the various display options above get applied by the used entity display.

Overrides FieldDefinitionInterface::getDisplayOptions

See also

\Drupal\Core\Entity\Display\EntityDisplayInterface

File

core/lib/Drupal/Core/Field/BaseFieldDefinition.php, line 411

Class

BaseFieldDefinition

A class for defining entity fields.

Namespace

Drupal\Core\Field

Code

public function getDisplayOptions($display_context) {
  return $this->definition['display'][$display_context]['options'] ?? NULL;
}