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

Twitter updates

  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022
  • Implementing and using TinyMCE 6 in ProcessWire– More
    16 December 2022

Latest news

  • ProcessWire Weekly #454
    In the 454th issue of ProcessWire Weekly we'll introduce a couple of brand new third party modules, check out what's new in the latest dev version of ProcessWire (3.0.211), and more. Read on!
    Weekly.pw / 21 January 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • Subscribe to weekly ProcessWire news

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