Parameter: |
Description: |
Default: |
"name" |
The name of a URL parameter |
required |
default="..." |
Default value in case parameter is empty or missing |
empty string |
newline="<br />" |
Convert newlines in textarea to other delimiters |
no conversion |
encode="entity" |
Encode special characters into HTML entities. See [[Main/WebHome#VarENCODE]] 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="[[$item]]" |
If set, gets all selected elements of a <select multiple="multiple"> 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: `%URLPARAM{"skin"}%` returns `print` for a `.../view/%WEB%/%INCLUDINGTOPIC%?skin=print` URL
- **_%X% Note:_** URL parameters passed into HTML form fields must be entity [[ENCODEd|Main/WebHome#VarENCODE]].
- **_%X% Note:_** Double quotes in URL parameters must be escaped when passed into other TWiki variables.%BR% Example: `%SEARCH{ "%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: [[ENCODE|Main/WebHome#VarENCODE]], [[SEARCH|Main/WebHome#VarSEARCH]], [[FormattedSearch]], [[QUERYSTRING|Main/WebHome#VarQUERYSTRING]]