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 $form_state['values'] for this element, or nothing to use the default.

Related topics

1 call to form_type_textarea_value()
FormTextareaTestCase::testValueCallback in modules/simpletest/tests/form.test
Tests that textarea value is properly set.

File

includes/form.inc, line 2591

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 : '';
    }
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.