function hook_field_is_empty

1 field.api.php hook_field_is_empty($item, $field, $instance)

Define what constitutes an empty item for a field type.

@since 1.33.0 Added parameter $instance.

Parameters

array $item: An item that may or may not be empty.

array $field: The field to which $item belongs.

array $instance: Field API instance definition.

Return value

bool: TRUE if $field's type considers $item not to contain any data; FALSE otherwise.

Related topics

Field Types API Define field types. Hooks Allow modules to interact with the Backdrop core.

13 functions implement hook_field_is_empty()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

date_field_is_empty in core/modules/date/date.field.inc: Implements hook_field_is_empty().
email_field_is_empty in core/modules/email/email.module: Implements hook_field_is_empty().
entityreference_field_is_empty in core/modules/entityreference/entityreference.module: Implements hook_field_is_empty().
field_example_field_is_empty in modules/examples/field_example/field_example.module: Implements hook_field_is_empty().
field_permission_example_field_is_empty in modules/examples/field_permission_example/field_permission_example.module: Implements hook_field_is_empty().

... See full list

File

core/modules/field/field.api.php, line 709: Hooks provided by the Field module.

Code

function hook_field_is_empty($item, $field, $instance) {
  if (empty($item['value']) && (string) $item['value'] !== '0') {
    return TRUE;
  }
  return FALSE;
}