Same name and namespace in other branches
  1. 4.7.x includes/form.inc \theme_checkbox()
  2. 5.x includes/form.inc \theme_checkbox()
  3. 7.x includes/form.inc \theme_checkbox()

Format a checkbox.

Parameters

$element: An associative array containing the properties of the element. Properties used: title, value, return_value, description, required

Return value

A themed HTML string representing the checkbox.

Related topics

File

includes/form.inc, line 1980

Code

function theme_checkbox($element) {
  _form_set_class($element, array(
    'form-checkbox',
  ));
  $checkbox = '<input ';
  $checkbox .= 'type="checkbox" ';
  $checkbox .= 'name="' . $element['#name'] . '" ';
  $checkbox .= 'id="' . $element['#id'] . '" ';
  $checkbox .= 'value="' . $element['#return_value'] . '" ';
  $checkbox .= $element['#value'] ? ' checked="checked" ' : ' ';
  $checkbox .= drupal_attributes($element['#attributes']) . ' />';
  if (!is_null($element['#title'])) {
    $checkbox = '<label class="option" for="' . $element['#id'] . '">' . $checkbox . ' ' . $element['#title'] . '</label>';
  }
  unset($element['#title']);
  return theme('form_element', $element, $checkbox);
}