Home › API reference › form.inc

form_type_textfield_value

  1. drupal
    1. 6
    2. 7
Versions
6 form_type_textfield_value($form, $edit = FALSE)
7 form_type_textfield_value($element, $input = FALSE)

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

Parameters

$element The form element whose value is being populated.

$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

drupal/includes/form.inc, line 2340

<?php
function form_type_textfield_value($element, $input = FALSE) {
  if ($input !== FALSE && $input !== NULL) {
    // Equate $input to the form value to ensure it's marked for
    // validation.
    return str_replace(array("\r", "\n"), '', $input);
  }
}
?>