form_file

Versions

4.6

form_file($title, $name, $size, $description = NULL, $required = FALSE)

Format a file upload field.

For assistance with handling the uploaded file correctly, see the API provided by file.inc.

Parameters

$title The label for the file upload field.

$name The internal name used to refer to the field.

$size A measure of the visible size of the field (passed directly to HTML).

$description Explanatory text to display after the form item.

$required Whether the user must upload a file to the field.

Return value

A themed HTML string representing the field.

Related topics

Input validation

Functions to validate user input.

Form generation

Functions to enable output of HTML forms and form elements.

Code

includes/common.inc, line 1355

<?php
function form_file($title, $name, $size, $description = NULL, $required = FALSE) {
  return theme('form_element', $title, '<input type="file" class="'. _form_get_class('form-file', $required, _form_get_error($name)) .'" name="edit['. $name .']" id="edit-'. $name .'" size="'. $size ."\" />\n", $description, 'edit-'. $name, $required, _form_get_error($name));
}
?>

Login or register to post comments