$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.236

Latest news

  • ProcessWire Weekly #547
    In the 547th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a couple of new modules, and more. Read on!
    Weekly.pw / 2 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer