field_get_items

7 field.module	`field_get_items($entity_type, $entity, $field_name, $langcode = NULL)`
8 field.module	`field_get_items($entity_type, $entity, $field_name, $langcode = NULL)`

Returns the field items in the language they currently would be displayed.

Parameters

$entity_type: The type of $entity; e.g., 'node' or 'user'.

$entity: The entity containing the data to be displayed.

$field_name: The field to be displayed.

$langcode: (optional) The language code $entity->{$field_name} has to be displayed in. Defaults to the current language.

Return value

An array of field items keyed by delta if available, FALSE otherwise.

3 functions call field_get_items()

File

modules/field/field.module, line 970: Attach custom data fields to Drupal entities.

Code

<?php
function field_get_items($entity_type, $entity, $field_name, $langcode = NULL) {
  $langcode = field_language($entity_type, $entity, $field_name, $langcode);
  return isset($entity->{$field_name}[$langcode]) ? $entity->{$field_name}[$langcode] : FALSE;
}
?>

Comments

Related API Function field_view_value()

Posted by jacobson on December 17, 2011 at 3:21am

It is worth noting that field_get_items() returns raw values the use of which can be a security risk. Passing the raw values through field_view_value() handles the sanitizing of the values.

Context

Posted by plach on January 10, 2012 at 1:46am

field_get_items() without an explicit langcode parameter should be used only in a display/render context since it will return the field items corresponding to the current display language.