public function BaseFieldDefinition::isInternal in Drupal 10

Same name and namespace in other branches

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

Determines whether the data value is internal.

This can be used in a scenario when it is not desirable to expose this data value to an external system.

The implications of this method are left to the discretion of the caller. For example, a module providing an HTTP API may not expose entities of this type, or a custom entity reference field settings form may deprioritize entities of this type in a select list.

Return value

bool Whether the data value is internal.

Overrides DataDefinition::isInternal

File

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

Class

BaseFieldDefinition

A class for defining entity fields.

Namespace

Drupal\Core\Field

Code

public function isInternal() {

  // All fields are not internal unless explicitly set.
  return !empty($this->definition['internal']);
}