- Patch #520946 by jhodgdon: fixed error in API documentation of form_set_error().

merge-requests/26/head
Dries Buytaert 2009-12-04 16:29:15 +00:00
parent a44f72acf0
commit 99128df8d0
1 changed files with 3 additions and 5 deletions

View File

@ -969,7 +969,7 @@ function form_execute_handlers($type, &$form, &$form_state) {
} }
/** /**
* File an error against a form element. * Files an error against a form element.
* *
* @param $name * @param $name
* The name of the form element. If the #parents property of your form * The name of the form element. If the #parents property of your form
@ -978,11 +978,9 @@ function form_execute_handlers($type, &$form, &$form_state) {
* element where the #parents array starts with 'foo'. * element where the #parents array starts with 'foo'.
* @param $message * @param $message
* The error message to present to the user. * The error message to present to the user.
* @param $reset
* Reset the form errors static cache.
* @return * @return
* Never use the return value of this function, use form_get_errors and * Return value is for internal use only. To get a list of errors, use
* form_get_error instead. * form_get_errors() or form_get_error().
*/ */
function form_set_error($name = NULL, $message = '') { function form_set_error($name = NULL, $message = '') {
$form = &drupal_static(__FUNCTION__, array()); $form = &drupal_static(__FUNCTION__, array());