form_type_checkbox_value

Drupal 6
Drupal 7

View documentation
List references

Definition

form_type_checkbox_value($form, $edit = FALSE)
includes/form.inc, line 1166

Description

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.

Name	Description
Form generation	Functions to enable the processing and display of HTML forms.

Code

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