$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 sanitizedd 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.130

Twitter updates

  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019

Latest news

  • ProcessWire Weekly #258
    In the 258th issue of ProcessWire Weekly we'll cover a hosting upgrade for the processwire.com site and it's subdomains, introduce PW Review and Terminal module, and feature the new site of O'Neil Cinema. Read on!
    Weekly.pw / 20 April 2019
  • ProcessWire.com website hosting upgrades
    Quietly and without interruption this week, our whole website moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before.
    Blog / 19 April 2019
  • 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