function hook_field_instance_settings_form

Add settings to an instance field settings form.

Invoked from \Drupal\field_ui\Form\FieldInstanceEditForm to allow the module defining the field to add settings for a field instance.

Parameters

$field: The field structure being configured.

$instance: The instance structure being configured.

array $form_state: The form state of the (entire) configuration form.

Return value

The form definition for the field instance settings.

Related topics

File

drupal/core/modules/field_ui/field_ui.api.php, line 67

Hooks provided by the Field UI module.

Code

function hook_field_instance_settings_form($field, $instance, $form_state) {
  $settings = $instance['settings'];
  $form['text_processing'] = array(
    '#type' => 'radios',
    '#title' => t('Text processing'),
    '#default_value' => $settings['text_processing'],
    '#options' => array(
      t('Plain text'),
      t('Filtered text (user selects text format)'),
    ),
  );
  if ($field['type'] == 'text_with_summary') {
    $form['display_summary'] = array(
      '#type' => 'select',
      '#title' => t('Display summary'),
      '#options' => array(
        t('No'),
        t('Yes'),
      ),
      '#description' => t('Display the summary to allow the user to input a summary value. Hide the summary to automatically fill it with a trimmed portion from the main post.'),
      '#default_value' => !empty($settings['display_summary']) ? $settings['display_summary'] : 0,
    );
  }
  return $form;
}