$input->queryStringClean() method

Return a cleaned query string that was part of this request, or blank if none

Note: it is recommended that you always specify $options with this method as the defaults may or may not be consistent with your needs.

Available since version 3.0.167.


// basic usage
$string = $input->queryStringClean();

// usage with all arguments
$string = $input->queryStringClean(array $options = []);


options (optional)array
  • values (array): Optional associative array of [name=value] to use in query string rather than current GET vars. (default=[])
  • overrides (array): Array of values to override or add to current request values. (default=[])
  • validNames (array): Only include query string variables with these names, and omit any others. (default=[])
  • maxItems (int): Maximum number of variables/items to include in the query string or 0 for no max. (default=20)
  • maxLength (int): Max overall length of returned query string or 0 for no max. (default=1024)
  • maxNameLength (int): Max length of any “name” in the “name=value” portion of a query string or 0 for no max. (default=50)
  • maxValueLength (int): Max length of any “value” in the “name=value” portion of a query string or 0 for no max. (default=255)
  • maxArrayDepth (int): Maximum depth for arrays, or 0 to disallow arrays. (default=0)
  • maxArrayItems (int): Maximum number of items allowed in arrays or 0 for no max. (default=20)
  • associative (bool): Allow associative arrays? (default=false)
  • sanitizeName (string): Sanitize query string variable names with this sanitizer method or blank to ignore. (default='fieldName')
  • sanitizeValue (string): Sanitize query string variable values with this sanitizer method or blank to ignore. (default='line')
  • sanitizeRemove (bool): Remove any variables from query string that are changed as the result of sanitization? (default=true)
  • entityEncode (bool): Should returned query string be entity encoded for HTML output? (default=true)
  • encType (int): Use PHP_QUERY_RFC3986 for spaces encoded to '%20' or PHP_QUERY_RFC1738 for spaces as '+'. (default=PHP_QUERY_RFC3986)
  • separator (string): Character(s) that separate each “name=value” in query string. (default='&')

Return value


$input methods and properties

API reference based on ProcessWire core version 3.0.185

Twitter updates

  • ProcessWire 3.0.192 (dev branch) contains 11 issue fixes and 5 pull requests, over 20 commits— More
    7 January 2022
  • ProcessWire 3.0.191 core updates: updates to the installer and the profile exporter module— More
    24 December 2021
  • This week ProcessWire went on a diet, trimming the core size from 15.5 MB down to 7.5 MB by moving optional site profiles into their own GitHub repos— More
    17 December 2021

Latest news

  • ProcessWire Weekly #401
    In the 401st issue of ProcessWire Weekly we'll cover the latest core updates, check out a brand new module called Lister Native Date Format, and more. Read on!
    Weekly.pw / 15 January 2022
  • ProcessWire 3.0.190 core updates
    ProcessWire 3.0.190 has 15 commits relative to 3.0.189 and contains a mixture of issue resolutions and feature additions. This post covers them all, in addition to updates for the PageAutosave and ProFields Table modules.
    Blog / 3 December 2021
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.