function hook_field_formatter_settings_form_alter

1 field.api.php hook_field_formatter_settings_form_alter(&$settings_form, $context)

Alter the form elements for a formatter's settings.

@since 1.13.0

Parameters

$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()

Related topics

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

1 function implements hook_field_formatter_settings_form_alter()

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

field_test_field_formatter_settings_form_alter in core/modules/field/tests/field_test/field_test.module: Implements hook_field_formatter_settings_form_alter().

File

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

Code

function hook_field_formatter_settings_form_alter(&$settings_form, $context) {

}