form_type_checkbox_value

• Drupal 6
• Drupal 7

Versions

6

form_type_checkbox_value($form, $edit = FALSE)

7

form_type_checkbox_value($element, $input = FALSE)

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

Parameters

$form The form element whose value is being populated.

• @param $input The incoming input 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 $element_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.

Code

includes/form.inc, line 1447

<?php
function form_type_checkbox_value($element, $input = FALSE) {
  if ($input !== FALSE) {
    if (empty($element['#disabled'])) {
      // Successful (checked) checkboxes are present with a value (possibly '0').
      // http://www.w3.org/TR/html401/interact/forms.html#successful-controls
      // For an unchecked checkbox, we return numeric 0, so we can explicitly
      // test for a value different than string '0'.
      return isset($input) ? $element['#return_value'] : 0;
    }
    else {
      // Disabled form controls are not submitted by the browser. Ignore any
      // submitted value and always return default.
      return $element['#default_value'];
    }
  }
}
?>

Login or register to post comments