Index: includes/form.inc =================================================================== RCS file: /cvs/drupal/drupal/includes/form.inc,v retrieving revision 1.506 diff -u -p -r1.506 form.inc --- includes/form.inc 21 Oct 2010 20:46:58 -0000 1.506 +++ includes/form.inc 23 Oct 2010 14:15:21 -0000 @@ -1228,16 +1228,11 @@ function _form_validate(&$elements, &$fo $is_empty_string = (is_string($elements['#value']) && drupal_strlen(trim($elements['#value'])) == 0); $is_empty_value = ($elements['#value'] === 0); if ($is_empty_multiple || $is_empty_string || $is_empty_value) { - // Although discouraged, a #title is not mandatory for form elements. In - // case there is no #title, we cannot set a form error message. - // Instead of setting no #title, form constructors are encouraged to set - // #title_display to 'invisible' to improve accessibility. - if (isset($elements['#title'])) { - form_error($elements, $t('!name field is required.', array('!name' => $elements['#title']))); - } - else { - form_error($elements); - } + // Flag this element as #required_is_empty to allow #element_validate + // handlers to set a custom required error message, but without having + // to re-implement the complex logic to figure out whether the field + // value is empty. + $elements['#required_is_empty'] = TRUE; } } @@ -1252,6 +1247,24 @@ function _form_validate(&$elements, &$fo $function($elements, $form_state, $form_state['complete form']); } } + + // Ensure that a #required form error is thrown, regardless of whether + // #element_validate handlers changed any properties. If $is_empty_value + // is defined, then above #required validation code ran, so the other + // variables are also known to be defined and we can test them again. + if (isset($is_empty_value) && ($is_empty_multiple || $is_empty_string || $is_empty_value)) { + // Although discouraged, a #title is not mandatory for form elements. In + // case there is no #title, we cannot set a form error message. + // Instead of setting no #title, form constructors are encouraged to set + // #title_display to 'invisible' to improve accessibility. + if (isset($elements['#title'])) { + form_error($elements, $t('!name field is required.', array('!name' => $elements['#title']))); + } + else { + form_error($elements); + } + } + $elements['#validated'] = TRUE; } Index: modules/simpletest/tests/form.test =================================================================== RCS file: /cvs/drupal/drupal/modules/simpletest/tests/form.test,v retrieving revision 1.72 diff -u -p -r1.72 form.test --- modules/simpletest/tests/form.test 4 Oct 2010 18:00:46 -0000 1.72 +++ modules/simpletest/tests/form.test 23 Oct 2010 14:19:30 -0000 @@ -123,6 +123,44 @@ class FormsTestCase extends DrupalWebTes } /** + * Tests #required with custom validation errors. + * + * @see form_test_validate_required_form() + */ + function testRequiredValidation() { + $form = $form_state = array(); + $form = form_test_validate_required_form($form, $form_state); + + // Verify that a custom #required error can be set. + $edit = array(); + $this->drupalPost('form-test/validate-required', $edit, 'Submit'); + + foreach (element_children($form) as $key) { + if (isset($form[$key]['#required_error'])) { + $this->assertNoText(t('!name field is required.', array('!name' => $form[$key]['#title']))); + $this->assertText($form[$key]['#required_error']); + } + } + $this->assertNoText(t('An illegal choice has been detected. Please contact the site administrator.')); + + // Verify that no custom validation error appears with valid values. + $edit = array( + 'textfield' => $this->randomString(), + 'checkboxes[foo]' => TRUE, + 'select' => 'foo', + ); + $this->drupalPost('form-test/validate-required', $edit, 'Submit'); + + foreach (element_children($form) as $key) { + if (isset($form[$key]['#required_error'])) { + $this->assertNoText(t('!name field is required.', array('!name' => $form[$key]['#title']))); + $this->assertNoText($form[$key]['#required_error']); + } + } + $this->assertNoText(t('An illegal choice has been detected. Please contact the site administrator.')); + } + + /** * Test default value handling for checkboxes. * * @see _form_test_checkbox() Index: modules/simpletest/tests/form_test.module =================================================================== RCS file: /cvs/drupal/drupal/modules/simpletest/tests/form_test.module,v retrieving revision 1.52 diff -u -p -r1.52 form_test.module --- modules/simpletest/tests/form_test.module 20 Oct 2010 01:15:58 -0000 1.52 +++ modules/simpletest/tests/form_test.module 23 Oct 2010 14:10:42 -0000 @@ -24,6 +24,12 @@ function form_test_menu() { 'access arguments' => array('access content'), 'type' => MENU_CALLBACK, ); + $items['form-test/validate-required'] = array( + 'title' => 'Form #required validation', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('form_test_validate_required_form'), + 'access callback' => TRUE, + ); $items['form-test/limit-validation-errors'] = array( 'title' => 'Form validation with some error suppression', 'page callback' => 'drupal_get_form', @@ -304,6 +310,48 @@ function form_test_validate_form_validat } /** + * Form constructor for simple #required tests. + */ +function form_test_validate_required_form($form, &$form_state) { + $form['textfield'] = array( + '#type' => 'textfield', + '#title' => 'Name', + '#required' => TRUE, + '#required_error' => t('Please enter a name.'), + '#element_validate' => array('form_test_validate_required_form_element_validate'), + ); + $form['checkboxes'] = array( + '#type' => 'checkboxes', + '#title' => 'Checkboxes', + '#options' => drupal_map_assoc(array('foo', 'bar')), + '#required' => TRUE, + '#required_error' => t('Please choose at least one option.'), + '#element_validate' => array('form_test_validate_required_form_element_validate'), + ); + $form['select'] = array( + '#type' => 'select', + '#title' => 'Select', + '#options' => drupal_map_assoc(array('foo', 'bar')), + '#required' => TRUE, + '#required_error' => t('Please select something.'), + '#element_validate' => array('form_test_validate_required_form_element_validate'), + ); + $form['actions'] = array('#type' => 'actions'); + $form['actions']['submit'] = array('#type' => 'submit', '#value' => 'Submit'); + return $form; +} + +/** + * Form element validation handler for 'Name' field in form_test_validate_required_form(). + */ +function form_test_validate_required_form_element_validate($element, &$form_state) { + // Set a custom validation error on the #required element. + if (!empty($element['#required_is_empty'])) { + form_error($element, $element['#required_error']); + } +} + +/** * Builds a simple form with a button triggering partial validation. */ function form_test_limit_validation_errors_form($form, &$form_state) {