$input→queryStringClean()

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.

Usage

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

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

Arguments

NameType(s)Description
$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

string

$input methods and properties

API reference based on ProcessWire core version 3.0.251