$sanitizer->flatArray() method

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.214

Twitter updates

    Error retrieving Twitter status

Latest news

  • ProcessWire Weekly #471
    In the 471st issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party textformatter module for video embedding, and more. Read on!
    Weekly.pw / 20 May 2023
  • A look at the new Page Edit Restore module
    The new Page Edit Restore module helps to prevent page edits in the admin from getting lost when the user’s session is lost. This post covers it in detail.
    Blog / 12 May 2023
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer