You are here

public function FieldConfigBase::isRequired in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Field/FieldConfigBase.php \Drupal\Core\Field\FieldConfigBase::isRequired()
  2. 9 core/lib/Drupal/Core/Field/FieldConfigBase.php \Drupal\Core\Field\FieldConfigBase::isRequired()

Returns whether the field can be empty.

If a field is required, an entity needs to have at least a valid, non-empty item in that field's FieldItemList in order to pass validation.

An item is considered empty if its isEmpty() method returns TRUE. Typically, that is if at least one of its required properties is empty.

Return value

bool TRUE if the field is required.

Overrides FieldDefinitionInterface::isRequired

See also

\Drupal\Core\TypedData\Plugin\DataType\ItemList::isEmpty()

\Drupal\Core\Field\FieldItemInterface::isEmpty()

\Drupal\Core\TypedData\DataDefinitionInterface:isRequired()

\Drupal\Core\TypedData\TypedDataManager::getDefaultConstraints()

File

core/lib/Drupal/Core/Field/FieldConfigBase.php, line 380

Class

FieldConfigBase
Base class for configurable field definitions.

Namespace

Drupal\Core\Field

Code

public function isRequired() {
  return $this->required;
}