function FieldDefinition::setDisplayConfigurable
Same name in other branches
- 9 core/lib/Drupal/Core/Field/FieldDefinition.php \Drupal\Core\Field\FieldDefinition::setDisplayConfigurable()
- 8.9.x core/lib/Drupal/Core/Field/FieldDefinition.php \Drupal\Core\Field\FieldDefinition::setDisplayConfigurable()
- 10 core/lib/Drupal/Core/Field/FieldDefinition.php \Drupal\Core\Field\FieldDefinition::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
$this
File
-
core/
lib/ Drupal/ Core/ Field/ FieldDefinition.php, line 114
Class
- FieldDefinition
- A class for defining entity field definitions.
Namespace
Drupal\Core\FieldCode
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;
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.