Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...

URLPARAM{"name"} -- get value of a URL parameter

  • Returns the value of a URL parameter.
  • Syntax: %URLPARAM{"name"}%
  • Supported parameters:
    Parameter:up Description: Default:
    "name" The name of a URL parameter required
    default="..." Default value in case parameter is empty or missing empty string
    encode="entity" Encode special characters into HTML entities. See ENCODE for more details. 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
    encode="url" Encode special characters for URL parameter use, like a double quote into %22 no encoding
    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
    newline="<br />" Convert newlines in textarea to other delimiters no conversion
    separator=", " Separator between multiple selections. Only relevant if multiple is specified "\n" (new line)
  • Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/VarURLPARAM?skin=print URL
  • ALERT! Note: URL parameters passed into HTML form fields must be entity ENCODEd.
  • ALERT! Note: Double quotes in URL parameters must be escaped when passed into other TWiki variables.
    Example: %SEARCH{ "%URLPARAM{ "search" encode="quotes" }%" noheader="on" }%
  • ALERT! 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.
  • ALERT! Note: There is a risk that this variable could be misused for cross-site scripting.
  • Related: ENCODE, SEARCH, FormattedSearch, QUERYSTRING


Webs Webs

r2 - 04 Jan 2007 - 01:27:16 - TWikiContributor
This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
Syndicate this site RSSATOM