public function BaseFieldDefinition::setDisplayConfigurable in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Field/BaseFieldDefinition.php \Drupal\Core\Field\BaseFieldDefinition::setDisplayConfigurable()

Sets whether the display for the field can be configured.

Parameters

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

bool $configurable: Whether the display options can be configured (e.g., via the "Manage display" / "Manage form display" UI screens). If TRUE, the options specified via getDisplayOptions() act as defaults.

Return value

static The object itself for chaining.

File

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

Class

BaseFieldDefinition

A class for defining entity fields.

Namespace

Drupal\Core\Field

Code

public function setDisplayConfigurable($display_context, $configurable) {

  // If no explicit display options have been specified, default to 'hidden'.
  if (empty($this->definition['display'][$display_context])) {
    $this->definition['display'][$display_context]['options'] = [
      'region' => 'hidden',
    ];
  }
  $this->definition['display'][$display_context]['configurable'] = $configurable;
  return $this;
}