function hook_field_formatter_info_alter

You are here

Drupal 7 » field.api.php
7 field.api.php hook_field_formatter_info_alter(&$info)
8 field.api.php hook_field_formatter_info_alter(array &$info)

Perform alterations on Field API formatter types.

Parameters

$info: An array of information on formatter types exposed by hook_field_formatter_info() implementations.

Related topics

Field Formatter API
Define Field API formatter types.
Hooks
Allow modules to interact with the Drupal core.

File

modules/field/field.api.php, line 1094

Code

function hook_field_formatter_info_alter(&$info) {
  // Add a setting to a formatter type.
  $info['text_default']['settings'] += array(
    'mymodule_additional_setting' => 'default value',
  );

  // Let a new field type re-use an existing formatter.
  $info['text_default']['field types'][] = 'my_field_type';
}

Comments

Posted by xcf33 on

When using the hook, don't forget to specify the module element as well (not mentioned in the docs)

<?php
$info['your_formatter_name'] = array(
    'label' => t('Label'),
    'field types' => array('field_type'),
    'module' => 'name_of_your_module',
  );
?>