form_type_checkboxes_value

Helper function to determine the value for a checkboxes form element.

Parameters

$form: The form element whose value is being populated.

$edit: The incoming POST data to populate the form element. If this is FALSE, the element's default value should be returned.

Return value

The data that will appear in the $form_state['values'] collection for this element. Return nothing to use the default.

Related topics

Form generation

Functions to enable the processing and display of HTML forms.

File

includes/form.inc, line 1213

Code

function form_type_checkboxes_value($form, $edit = FALSE) {
  if ($edit === FALSE) {
    $value = array();
    $form += array('#default_value' => array());
    foreach ($form['#default_value'] as $key) {
      $value[$key] = 1;
    }
    return $value;
  }
  elseif (!isset($edit)) {
    return array();
  }
}