function multiselect_widget in Multiselect 6

Same name and namespace in other branches

1. 5.2 multiselect.module \multiselect_widget()
2. 5 multiselect.module \multiselect_widget()

Implementation of hook_widget().

hook_widget is a CCK hook

Attach a single form element to the form. It will be built out and validated in the callback(s) listed in hook_elements. We build it out in the callbacks rather than here in hook_widget so it can be plugged into any module that can provide it with valid $field information.

Content module will set the weight, field name and delta values for each form element. This is a change from earlier CCK versions where the widget managed its own multiple values.

If there are multiple values for this field, the content module will call this function as many times as needed.

Parameters

$form: the entire form array, $form['#node'] holds node information

$form_state: the form_state, $form_state['values'] holds the form values.

$field: the field array

$delta: the order of this item in the array of subelements (0, 1, 2, etc)

Return value

the form item for a single element for this field

File

./multiselect.module, line 137

Allows users to select multiple items in an easier way than the normal node-reference widget.

Code

function multiselect_widget(&$form, &$form_state, $field, $items, $delta = 0) {
  switch ($field['widget']['type']) {
    case 'multiselect_select':
      $element = array(
        '#type' => 'multiselect_select',
        '#default_value' => $items,
      );
      break;
  }
  return $element;
}