Home › API reference

form_item

Definition

form_item($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE)
drupal/includes/common.inc, line 1054

Description

Format a general form item.

Parameters

$title The label for the form item.

$value The contents of the form item.

$description Explanatory text to display after the form item.

$id A unique identifier for the form item.

$required Whether the user must fill in this form element before submitting the form.

$error An error message to display alongside the form element.

Return value

A themed HTML string representing the form item.

Related topics

Namesort iconDescription
Form generationFunctions to enable output of HTML forms and form elements.
Input validationFunctions to validate user input.

Code

function form_item($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE) {
  return theme('form_element', $title, $value, $description, $id, $required, $error);
}