$sanitizer→flatArray()

Given a potentially multi-dimensional array, return a flat 1-dimensional array

Available since version 3.0.160.

Usage

// basic usage
$array = $sanitizer->flatArray(array $value);

// usage with all arguments
$array = $sanitizer->flatArray(array $value, array $options = []);

Arguments

NameType(s)Description
$valuearray
$options (optional)array
  • preserveKeys (bool): Preserve associative array keys where possible? Default:false
  • maxDepth (int): Max depth of nested arrays to flatten into value, after which they are discarded Default:0 The default value of 0 removes any nested arrays, so specify 1 or higher to include them.

Return value

array

$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.252