$input->whitelist() method

Get or set a whitelist variable

Whitelist variables are used by modules and templates and assumed to be sanitized. Only place variables in the whitelist that you have already sanitized.

The whitelist is a list of variables specifically set by the application as sanitized for use elsewhere in the application. This whitelist is not specifically used by ProcessWire unless you populate it from your templates or the API. When populated, it is used by the MarkupPagerNav module (for instance) to ensure that sanitized query string (GET) variables are maintained across paginations.

Examples

// Retrieve a GET variable, sanitize/validate it, and populate to whitelist
$limit = (int) $input->get('limit');
if($limit < 10 || $limit > 100) $limit = 25; // validate
$input->whitelist('limit', $limit); 
// Retrieve a variable from the whitelist
$limit = $input->whitelist('limit'); 

Usage

// basic usage
$mixed = $input->whitelist();

// usage with all arguments
$mixed = $input->whitelist(string $key = '', mixed $value = null);

Arguments

NameType(s)Description
key (optional)string

Whitelist variable name that you want to get or set.

  • If $key is blank, it assumes you are asking to return the entire whitelist.
  • If $key and $value are populated, it adds the value to the whitelist.
  • If $key is an array, it adds all the values present in the array to the whitelist.
  • If $value is omitted, it assumes you are asking for a value with $key, in which case it returns it.
value (optional)mixed

Value you want to set (if setting a value). See explanation for the $key param.

Return value

null mixed WireInputData

Returns whitelist variable value if getting a value (null if it doesn't exist).


$input methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • New post: Multi-language field translation export/import — In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire… More
    5 August 2022
  • Weekly update, July 29: Continuing upgrades to ProcessWire’s comments system and FormBuilder, along with a working example—More
    29 July 2022
  • Weekly update for July 22– Looking back at what web development was like in the year 2000. Plus some more discussion on the path from CKEditor 4 to CkEditor 5 in ProcessWire: More
    22 July 2022

Latest news

  • ProcessWire Weekly #430
    In the 430th issue of ProcessWire Weekly we're going to check out some brand new third party modules, a new site of the week, and more. Read on!
    Weekly.pw / 7 August 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 2022
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull