HTML_QuickForm::registerRule() – Registers a new validation rule


require_once 'HTML/QuickForm.php';

void HTML_QuickForm::registerRule ( string $ruleName , string $type , string $data1 , string $data2 = null )


Registers a new validation rule


string $ruleName

Name of validation rule

string $type

Either: 'regex' or 'callback' ('function' is also kept for backward compatibility). If registering a subclass of HTML_QuickForm_Rule you can pass anything here, preferrably NULL or empty string.

string $data1

Name of function, regular expression, classname of HTML_QuickForm_Rule subclass or an instance of such class.

The callback function needs to return true or false, determining if the rule is passed or not.

string $data2

Object parent of above function, name of the file containing the subclass of HTML_QuickForm_Rule.


throws no exceptions thrown


since 1.0

This function can not be called statically.

Set error message for a form element (Previous) Returns registered validation rules (Next)
Last updated: Sat, 16 Feb 2019 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report.
View this page in:
  • English

User Notes:

Note by: kguest
One example of this is:

$form->registerRule('phone','regex', '/^[\d\-\.\s]+$/');

this rule will only allow numeric phone numbers with an optional separator between each grouping of numbers.
Separator may be either a space, hyphen, full-stop/period.