[D7] Extrafield Settings

Description

This module adds the ability for module creators and developers to add formatter-like settings forms to the Field UI Display Overview form for their field_extra_fields. The goal is to provide a way for developers to supply basic per-bundle configuration options to their extra_fields similar to the manner in which field_formatters can take display settings. The settings options handled by this module are stored in field_bundle_settings along with the extra_field visibility options for easy saving and retrieval.

To create a settings form for an extra field a developer should supply a `settings callback` in their `hook_field_extra_fields()` definition, and from that callback return a valid Form API renderable array that can be merged in to the Field UI Display Overview form. This module also allows for an optional render callback to be set, allowing extra_fields to be automatically rendered with their settings. Below is an example usage of this module from the project's README:

Example Usage

  function hook_field_extra_fields() {
    $extra['entity_type']['bundle'] = array(
      'display' => array(
        'field_name' => array(
          'label' => 'Field Name',
          'weight' => 0,
          //
          // Below are the callbacks for extrafield_settings
          'callback' => 'example_field_name_render',
          'settings callback' => 'example_field_name_settings_form'
        ),
      ),
    );
    return $extra;
  }

  function example_field_name_settings_form($settings) {
    return array(
      'link_text' => array(
        '#type' => 'textfield',
        '#title' => isset($settings['link_text']) ? $settings['link_text'] : t('Click here'),
        '#description' => t('Link text for my custom button'),
      ),
    );
  }

  function example_field_name_render($entity, $type, $view_mode, $settings) {
    return array(
      '#theme' => 'link',
      '#title' => isset($settings['link_text']) ? $settings['link_text'] : t('Click here'),
      '#path' => entity_uri($type, $entity),
      '#options' => array(
        'attributes' => array(),
        'html' => FALSE,
      ),
    );
  }

Project Info

Project Page: https://www.drupal.org/project/extrafield_settings
Git clone: git clone --branch 7.x-1.x https://git.drupal.org/project/extrafield_settings.git

Manual Reviews of other projects

https://www.drupal.org/node/2597211#comment-12050759