CiviCRM Community Forums (archive)

Documentation page: http://wiki.civicrm.org/confluence/display/CRMDOC41/CiviCRM+hook+specification#CiviCRMhookspecification-hookcivicrmvalidate

documentation advises the hook implementation should return 'true if form validates successfully' but this causes the following warning to be issued ...

Warning: array_merge(): Argument #2 is not an array in CRM_Utils_Hook->runHooks() (line 125 of .../sites/all/modules/civicrm/CRM/Utils/Hook.php).

The code that gives the warning is ...

                if ( !empty( $fResult ) ) {
                    $result = array_merge( $result, $fResult );
                }

If $fResult is 'true' PHP doesn't consider it empty, and array_merge throws the warning.

Proposal: Change the documentation to say the function returns 'an array with input field names as keys and error message strings as values. The empty array indicates no validation errors'. The return statement in the examples should simply be 'return $errors;'

I'm happy to update the documentation, but wanted to socialise this first.

Ken