diff options
| author | webchick <webchick@24967.no-reply.drupal.org> | 2011-10-24 20:07:48 -0700 |
|---|---|---|
| committer | webchick <webchick@24967.no-reply.drupal.org> | 2011-10-24 20:07:48 -0700 |
| commit | 168bd186a6811c2c66dfc64b461d4e0f91150584 (patch) | |
| tree | cf04f3d7f8b283b4538b6893b0a4c7df8aac22fd /includes | |
| parent | c545f6eeddd41c16494067d66d48733cf49bc5c9 (diff) | |
| download | brdo-168bd186a6811c2c66dfc64b461d4e0f91150584.tar.gz brdo-168bd186a6811c2c66dfc64b461d4e0f91150584.tar.bz2 | |
Issue #570314 follow-up by jhodgdon, Mac_Weber: Fixed form_set_value() documentation needs more detail.
Diffstat (limited to 'includes')
| -rw-r--r-- | includes/form.inc | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/includes/form.inc b/includes/form.inc index 42c108b8e..e0bc9cba0 100644 --- a/includes/form.inc +++ b/includes/form.inc @@ -2404,11 +2404,13 @@ function form_type_token_value($element, $input = FALSE) { } /** - * Change submitted form values during form validation. + * Changes submitted form values in $form_state. * * Use this function to change the submitted value of a form element in a form * validation function, so that the changed value persists in $form_state - * through to the submission handlers. + * through the remaining validation and submission handlers. It does not change + * the value in $element['#value'], only in $form_state['values'], which is + * where submitted values are always stored. * * Note that form validation functions are specified in the '#validate' * component of the form array (the value of $form['#validate'] is an array of |