You are here

function hook_field_formatter_settings_form_alter in Field formatter settings 7

Alter the form elements for a formatter's settings.

Parameters

$settings_form: The settings form array from the field module's implementation of hook_field_formatter_settings().

$context: An array of additional context for the settings form, containing:

  • module: The module providing the formatter being configured.
  • formatter: The definition array of the formatter being configured. Note that this does not contain the machine name of the formatter. This can be found in:
$context['instance']['display'][$context['view_mode']]['type'];
  • field: The field structure being configured.
  • instance: The instance structure being configured.
  • view_mode: The view mode being configured.
  • form: The (entire) configuration form array, which will usually have no use here.
  • form_state: The form state of the (entire) configuration form.

See also

hook_field_formatter_settings()

File

./field_formatter_settings.api.php, line 37
Hooks provided by the Field formatter settings module.

Code

function hook_field_formatter_settings_form_alter(array &$settings_form, array $context) {
}