function FieldConfigInterface::setRequired

Same name in other branches
  1. 9 core/lib/Drupal/Core/Field/FieldConfigInterface.php \Drupal\Core\Field\FieldConfigInterface::setRequired()
  2. 8.9.x core/lib/Drupal/Core/Field/FieldConfigInterface.php \Drupal\Core\Field\FieldConfigInterface::setRequired()
  3. 11.x core/lib/Drupal/Core/Field/FieldConfigInterface.php \Drupal\Core\Field\FieldConfigInterface::setRequired()

Sets 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.

Parameters

bool $required: TRUE if the field is required. FALSE otherwise.

Return value

$this The current object, for a fluent interface.

1 method overrides FieldConfigInterface::setRequired()
FieldConfigBase::setRequired in core/lib/Drupal/Core/Field/FieldConfigBase.php
Sets whether the field can be empty.

File

core/lib/Drupal/Core/Field/FieldConfigInterface.php, line 111

Class

FieldConfigInterface
Defines an interface for configurable field definitions.

Namespace

Drupal\Core\Field

Code

public function setRequired($required);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.