$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 #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 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

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer