select_or_other.api.php in Select (or other) 7.3

API documentation for Select or other.

File

select_or_other.api.php

<?php

/**
 * @file
 * API documentation for Select or other.
 */

/**
 * Implements hook_select_or_other_available_options().
 *
 * Provide a list of options for a select or other field. Options can be keyed,
 * unkeyed or a combination of both. Keyed values should be entered in a
 * key|value fashion. Unkeyed options will automatically be keyed with a key
 * identical to the value.
 *
 * Options provided using this hook can be overwritten by options provided in
 * the 'Available options' field on the instance settings form.
 */
function hook_select_or_other_available_options($entity_type, $bundle, $field_name) {
  if ($entity_type === 'node' && $bundle === 'page' && $field_name === 'field_some_field') {
    return array(
      'keyed|A keyed value',
      'unkeyed',
    );
  }
}

/**
 * Implements hook_select_or_other_process_alter().
 *
 * Provide a hook to alter the widget depending on the context and form_state.
 * In this example we remove the attached files and remove the 'other' textfield
 * depending on the state of the form submitted.
 */
function hook_select_or_other_process_alter(&$element, &$form_state, $context) {
  unset($element['#attached']);
  if ($form_state['submitted']) {
    $element['other']['#access'] = FALSE;
  }
}

Functions

Name	Description
hook_select_or_other_available_options	Implements hook_select_or_other_available_options().
hook_select_or_other_process_alter	Implements hook_select_or_other_process_alter().