PHP filter_input_array() Function


PHP Filter Reference Complete PHP Filter Reference

Definition and Usage

The filter_input_array() function gets multiple external variables (like form input) and filters them.

This function is useful for filtering several input variables without calling filter_input() over and over.

This function can get input from several sources:

  • INPUT_GET
  • INPUT_POST
  • INPUT_COOKIE
  • INPUT_ENV
  • INPUT_SERVER
  • INPUT_SESSION (Not yet implemented)
  • INPUT_REQUEST (Not yet implemented)

Returns an array of filtered data on success, FALSE on failure.

Syntax

filter_input_array(input_type, filter_args)

Parameter Description
input_type Required. Specifies the input type. See possible types in list above
filter_args Optional. Specifies an array of filter arguments. A valid array key is a variable name and a valid value is a filter ID, or an array specifying the filter, flags and options.

This parameter can also be a single filter ID, if so, all values in the input array are filtered by the specified filter

A filter ID can be an ID name (like FILTER_VALIDATE_EMAIL) or an ID number (like 274)



Tips and Notes

Tip: Check the Complete PHP Filter Reference for possible filters to use with this function.


Example

In this example we use the filter_input_array() function to filter three POST variables. The received POST variables is a name, an age and an e-mail address:

<?php
$filters = array
  (
  "name" => array
    (
    "filter"=>FILTER_CALLBACK,
    "flags"=>FILTER_FORCE_ARRAY,
    "options"=>"ucwords"
    ),
  "age" => array
    (
    "filter"=>FILTER_VALIDATE_INT,
    "options"=>array
      (
      "min_range"=>1,
      "max_range"=>120
      )
    ),
  "email"=> FILTER_VALIDATE_EMAIL,
  );
print_r(filter_input_array(INPUT_POST, $filters));
?>

The output of the code should be:

Array
  (
  [name] => Peter
  [age] => 41
  [email] => peter@example.com
  )


PHP Filter Reference Complete PHP Filter Reference

Color Picker

colorpicker