$sanitizer->array() method

Sanitize array or CSV string to array of values, optionally sanitized by given method

If given a string, delimiter may be pipe ("|"), or comma (","), unless overridden with the delimiter or delimiters options.

Usage

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

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

Arguments

Name Type(s) Description

Name	Type(s)	Description
`value`	array, string, mixed	Accepts an array or CSV string. If given something else, it becomes first item in array.
`sanitizer` (optional)	string, array	Sanitizer method to apply to items in the array or omit/null for none, or in 3.0.165+ optionally substitute the $options argument here instead (default=null).
`options` (optional)	array	Optional modifications to default behavior: `maxItems` (int): Maximum items allowed in each array (default=0, which means no limit) `maxDepth` (int): Max nested array depth (default=0, which means no nesting allowed) Since 3.0.160 `trim` (bool): Trim whitespace from front/back of each string item in array? (default=true) Since 3.0.190 `sanitizer` (string): Optionally specify sanitizer for array values as option rather than argument (default='') Since 3.0.165 `keySanitizer` (string): Optionally sanitize associative array keys with this method (default='') Since 3.0.167 The following options are only used if the provided $value is a string: `csv` (bool): Allow conversion of delimited string to array? (default=true) Since 3.0.165 `delimiter` (string): Single delimiter to use to identify CSV strings. Overrides the 'delimiters' option when specified (default=null) `delimiters` (array): Delimiters to identify CSV strings. First found delimiter will be used, default=array("\|", ",") `enclosure` (string): Enclosure to use for CSV strings (default=double quote, i.e. `"`)

value

array, string, mixed

Accepts an array or CSV string. If given something else, it becomes first item in array.

sanitizer (optional)

string, array

Sanitizer method to apply to items in the array or omit/null for none, or in 3.0.165+ optionally substitute the $options argument here instead (default=null).

options (optional)

array

Optional modifications to default behavior:

maxItems (int): Maximum items allowed in each array (default=0, which means no limit)
maxDepth (int): Max nested array depth (default=0, which means no nesting allowed) Since 3.0.160
trim (bool): Trim whitespace from front/back of each string item in array? (default=true) Since 3.0.190
sanitizer (string): Optionally specify sanitizer for array values as option rather than argument (default='') Since 3.0.165
keySanitizer (string): Optionally sanitize associative array keys with this method (default='') Since 3.0.167
The following options are only used if the provided $value is a string:
csv (bool): Allow conversion of delimited string to array? (default=true) Since 3.0.165
delimiter (string): Single delimiter to use to identify CSV strings. Overrides the 'delimiters' option when specified (default=null)
delimiters (array): Delimiters to identify CSV strings. First found delimiter will be used, default=array("|", ",")
enclosure (string): Enclosure to use for CSV strings (default=double quote, i.e. ")

Return value

array

Exceptions

Method can throw exceptions on error:

WireException - if an unknown $sanitizer method is given

Hooking $sanitizer->array(…)

You can add your own hook events that are executed either before or after the $sanitizer->array(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $sanitizer->array(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Sanitizer::array', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $sanitizer = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $value = $event->arguments(0);
  $sanitizer = $event->arguments(1);
  $options = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $value);
  $event->arguments(1, $sanitizer);
  $event->arguments(2, $options);
});

Hooking after

The 'after' hooks are called immediately after each $sanitizer->array(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Sanitizer::array', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $sanitizer = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $value = $event->arguments(0);
  $sanitizer = $event->arguments(1);
  $options = $event->arguments(2);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.236