Helper function to determine the value for a checkbox 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

File

drupal-6.x/includes/form.inc, line 1196

Code

function form_type_checkbox_value($form, $edit = FALSE) {
  if ($edit !== FALSE) {
    if (empty($form['#disabled'])) {
      return !empty($edit) ? $form['#return_value'] : 0;
    }
    else {
      return $form['#default_value'];
    }
  }
}