Form error reporting fallback does not respect Drupal documentation [#1432732]

In the function field_default_form_errors() (field.form.inc file), the following code is used for widgets that do not implement [widget]_field_widget_error() function:
form_error($error_element, $error['error']);

On the Drupal API for such function (http://api.drupal.org/api/drupal/modules!field!field.api.php/function/ho...), the given example uses form_error($element['value'], $error['message']);.

So there is a consistency issue there, where in the first case the $error['error'] value is used and in the standard case $error['message'].

This causes troubles for example in the Field validation module: http://drupal.org/node/1316368.

Comment	File	Size	Author
#11	formerrorskey-1432732-11.patch	980 bytes	Jorrit
#4	formerrorskey-1432732-4.patch	992 bytes	Jorrit
#1	field-form-error-reporting-fallback-is-wrong-1432732-1.patch	588 bytes	b-prod

Comments

Comment #1

b-prod commented 8 February 2012 at 13:45

Status:

Active

» Needs review

Status	File	Size
new	field-form-error-reporting-fallback-is-wrong-1432732-1.patch	588 bytes

The patch below modifies the fallback error reporting, according to the specifications of the FieldValidationException class, where the errors array is clearly defined as:

An array of field validation errors, keyed by field name and
delta that contains two keys:

'error': A machine-readable error code string, prefixed by the field module name. A field widget may use this code to decide how to report the error.

'message': A human-readable error message such as to be passed to form_error() for the appropriate form element.

Question: is there a specific reason for using the 'error' key (portability? I may miss something)? If so, then the image widget should implement image_field_widget_error() function.

Comment #2

Jorrit commented 2 June 2012 at 22:16

Status:

Needs review

» Reviewed & tested by the community

I agree with this patch entirely. The second argument to form_error should be human readable, so $error['message'] should be used, not $error['error'].

The example code of hook_field_widget_error() also demonstrates this.

Comment #3

Jorrit commented 2 June 2012 at 22:31

Status:

Needs review

» Needs work

The sample body for hook_field_widget_error does contain a bug: $element['value'] should be $element, I made #1614468: hook_field_widget_error example implementation contains error for that.

Also, Drupal 8 also contains this bug so I guess a patch must be made for that version first.