UnsetFilter

Implements FormFilterInterface

Form Filter class to unset

since

4.0.0

package

Application

Methods

filter

Method to filter a field value.

filter(\SimpleXMLElement element, mixed value, string group = null, \Joomla\Registry\Registry input = null, \Joomla\CMS\Form\Form form = null) : mixed
since

4.0.0

Arguments

element

\SimpleXMLElementThe SimpleXMLElement object representing the <field> tag for the form field object.

value

mixedThe form field value to validate.

group

stringThe field name group control value. This acts as an array container for the field. For example if the field has name="foo" and the group value is set to "bar" then the full field name would end up being "bar[foo]".

input

\Joomla\Registry\RegistryAn optional Registry object with the entire data set to validate against the entire form.

form

\Joomla\CMS\Form\FormThe form object for which the field is being tested.

Response

mixedThe filtered value.