function form_type_textarea_value

Determines the value for a textarea form element.

Parameters

array $element: The form element whose value is being populated.

mixed $input: The incoming input to populate the form element. If this is FALSE, the element's default value should be returned.

Return value

string 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.
1 call to form_type_textarea_value()
FormTextareaTestCase::testValueCallback in drupal/modules/simpletest/tests/form.test
Tests that textarea value is properly set.

File

drupal/includes/form.inc, line 2576
Functions for form and batch generation and processing.

Code

function form_type_textarea_value($element, $input = FALSE) {
  if ($input !== FALSE && $input !== NULL) {

    // This should be a string, but allow other scalars since they might be
    // valid input in programmatic form submissions.
    return is_scalar($input) ? (string) $input : '';
  }
}