1.20.x field.api.php hook_field_extra_fields_display_alter(&$displays, $context)

Alters the display settings of pseudo-fields before an entity is displayed.

This hook is called once per displayed entity. If the result of the hook involves reading from the database, it is highly recommended to statically cache the information.

Parameters

$displays: An array of display settings for the pseudo-fields in the entity, keyed by pseudo-field names.

$context: An associative array containing:

  • entity_type: The entity type; e.g., 'node' or 'user'.
  • bundle: The bundle name.
  • view_mode: The display mode, e.g. 'full', 'teaser'...

Related topics

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

File

modules/field/field.api.php, line 2446
Hooks provided by the Field module.

Code

function hook_field_extra_fields_display_alter(&$displays, $context) {
  if ($context['entity_type'] == 'taxonomy_term' && $context['view_mode'] == 'full') {
    $displays['description']['visible'] = FALSE;
  }
}