VarURLPARAM < TWiki

#VarURLPARAM

---+++ URLPARAM{"name"} -- get value of a URL parameter
   * Returns the value of a URL parameter.
   * Syntax: =%<nop>URLPARAM{"name"}%=
   * Supported parameters:
     | *Parameter:* | *Description:* | *Default:* |
     | ="name"= | The name of a URL parameter | required |
     | =default="..."= | Default value in case parameter is empty or missing | empty string |
     | =newline="&lt;br /&gt;"= | Convert newlines in textarea to other delimiters | no conversion |
     | =encode="entity"= | Encode special characters into HTML entities. See [[#VarENCODE][ENCODE]] for more details. | no encoding |
     | =encode="url"= | Encode special characters for URL parameter use, like a double quote into =%22= | no encoding |
     | =encode="quote"= | Escape double quotes with backslashes (=\"=), does not change other characters; required when feeding URL parameters into other TWiki variables | no encoding |
     | =multiple="on"= %BR% =multiple="[<nop>[$item]]"= | If set, gets all selected elements of a =&lt;select multiple="multiple"&gt;= tag. A format can be specified, with =$item= indicating the element, e.g. =multiple="Option: $item"= | first element |
     | =separator=", "= | Separator between multiple selections. Only relevant if multiple is specified | ="\n"= (new line) |
   * Example: =%<nop>URLPARAM{"skin"}%= returns =print= for a =.../view/%WEB%/%INCLUDINGTOPIC%?skin=print= URL
   * __%X% Note:__ URL parameters passed into HTML form fields must be entity [[#VarENCODE][ENCODEd]].
   * __%X% Note:__ Double quotes in URL parameters must be escaped when passed into other TWiki variables.%BR% Example: =%<nop>SEARCH{ "%<nop>URLPARAM{ "search" encode="quotes" }%" noheader="on" }%=
   * __%X% Note:__ When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
   * __%X% Note:__ There is a risk that this variable could be misused for cross-site scripting.
   * Related: [[#VarENCODE][ENCODE]], [[#VarSEARCH][SEARCH]], FormattedSearch, [[#VarQUERYSTRING][QUERYSTRING]]

This topic: TWiki > WebHome > TWikiVariables > VarURLPARAM
Topic revision: r2 - 2007-01-04 - TWikiContributor

Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.VarURLPARAM.