PHP Manual
PrevNext

filter_var

(no version information, might be only in CVS)

filter_var -- Filters a variable with a specified filter

Description

mixed filter_var ( mixed variable [, int filter [, mixed options]] )

Warning

This function is EXPERIMENTAL. The behaviour of this function, the name of this function, and anything else documented about this function may change without notice in a future release of PHP. Use this function at your own risk.

Parameters

variable

Value to filter, arrays are filtered recursively.

filter

ID of a filter to use. Defaults to FILTER_SANITIZE_STRING.

options

Associative array of options or bitwise disjunction of flags. If filter accepts options, flags can be provided in "flags" field of array. For the "callback" filter, callback type should be passed.

Return Values

Returns the filtered data, or FALSE if the filter fails.

Examples

Example 1. A filter_var() example

<?php
var_dump(filter_var('bob@example.com', FILTER_VALIDATE_EMAIL));
var_dump(filter_var('example.com', FILTER_VALIDATE_URL, FILTER_FLAG_SCHEME_REQUIRED));
?>

The above example will output:

string(15) "bob@example.com"
bool(false)

See Also

filter_var_array()
filter_input()
filter_input_array()
information about the callback type

PrevHomeNext
filter_var_arrayUpFirebird/InterBase Functions
Generated by agnoster's phpzomg. View Source