View source for Parser function extensions/en

<languages />
{{Magic words}}
{{outdated}}
A "'''[[Special:MyLanguage/Help:Extension:ParserFunctions|parser function]]'''" is a [[Special:MyLanguage/Help:Templates|template]]-like construct that returns a value based on at least one unnamed parameter, separated from the function name by a colon [''':'''].
There may be more parameters, as well; like those of ordinary templates, these additional parameters are each preceded by a "pipe" ['''|'''].
In the case of a [[w:Number sign|hash character]] [#] at the start of the function name (which prevents collision with namespaces and interwiki prefixes), this may or may not be considered part of the name.
If it is considered part of the name, the syntax is of the form

:<nowiki>{{</nowiki>''functionname'': ''argument 1'' | ''argument 2'' | ''argument 3''...}}

{{note|1=If the caller has '''no arguments''' to provide the parser function, then the form is simply <nowiki>{{</nowiki>''functionname'':<nowiki>}}</nowiki> or, when a hash character applies (as is normally the case) then the form is <nowiki>{{</nowiki>''#functionname'':<nowiki>}}</nowiki>. If the trailing colon is not supplied, then ''functionname'' is not recognized by the parser.}}

Arguments cannot directly contain "|" or "}}" except as part of the code of a template call, parser function call, variable, link or image, but they can contain them arbitrarily using a template, e.g., {{tim|!}}, or a parser function.

The code can specify whether the function name is case-sensitive.

The separation of the arguments from each other is with "|", and from the function name is with the first ":" The expansion of each of these pieces is standard, as in [[Special:ExpandTemplates]] (which is a good place to experiment, by the way, if you are learning this stuff) and is beyond the control of the parser function itself.

However, everything else can be different for each parser function, including:
*whether an argument is just a value, or of the form ''parname'' = ''parvalue'', or whatever
*if applicable, whether parameter names are case-sensitive

==Syntax prescribed by a parser function extension==
In view of the above, it is advantageous to make an extension such that the syntax to be used in an argument does ''not'' contain the [[w:Vertical_bar|pipe character]] "|" or double braces (more specifically, double closing braces "}}" ).
This, in spite of the fact that a pipe character would otherwise seem a suitable symbol for, e.g., a choice or union (see, e.g., [http://semeb.com/dpldemo/index.php/Manual#category]).
Allowing such codes is harmless if an alternative code is also allowed, e.g. "\" for "|".

==Table of functions==

{|class="sortable wikitable"
!extension!!function!!MediaWiki version
|-
|[[Special:MyLanguage/Help:Parser function#LC|built-in]]||lc||1.7+
|-
|[[Special:MyLanguage/Help:Parser function#UC|built-in]]||uc||1.7+
|-
|[[Special:MyLanguage/Help:Parser function#LCFIRST|built-in]]||lcfirst||1.7+
|-
|[[Special:MyLanguage/Help:Parser function#UCFIRST|built-in]]||ucfirst||1.7+
|-
|[[Special:MyLanguage/Help:Parser function#URLENCODE|built-in]]||urlencode||1.7+
|-
|[[Special:MyLanguage/Help:Parser function#ANCHORENCODE|built-in]]||anchorencode||1.8+
|-
|[[Special:MyLanguage/Help:Parser function#URLs etc.|built-in]]||localurl||1.7+
|-
|[[Special:MyLanguage/Help:Parser function#URLs etc.|built-in]]||fullurl||1.7+
|-
|[[Special:MyLanguage/Help:Parser function##language:|built-in]]||#language||1.7+
|-
|[[Special:MyLanguage/Help:Parser function#|built-in]]||#special||1.9+
|-
|[[Special:MyLanguage/Help:Parser function#|built-in]]||#tag||1.12+
|-
|{{ll|Extension:ParserFunctions|nsp=0}} ({{ll|Help:Extension:ParserFunctions##expr|usage}})||#expr||1.19+
|-
|{{ll|Extension:ParserFunctions|nsp=0}} ({{ll|Help:Extension:ParserFunctions##ifexpr|usage}})||#ifexpr||1.19+
|-
|{{ll|Extension:ParserFunctions|nsp=0}} ({{ll|Help:Extension:ParserFunctions##if|usage}})||#if||1.19+
|-
|{{ll|Extension:ParserFunctions|nsp=0}} ({{ll|Help:Extension:ParserFunctions##ifeq|usage}})||#ifeq||1.19+
|-
|{{ll|Extension:ParserFunctions|nsp=0}} ({{ll|Help:Extension:ParserFunctions##ifexist|usage}})||#ifexist||1.19+
|-
|{{ll|Extension:ParserFunctions|nsp=0}} ({{ll|Help:Extension:ParserFunctions##rel2abs|usage}})||#rel2abs||1.19+
|-
|{{ll|Extension:ParserFunctions|nsp=0}} ({{ll|Help:Extension:ParserFunctions##titleparts|usage}})||#titleparts||1.19+
|-
|{{ll|Extension:ParserFunctions|nsp=0}} ({{ll|Help:Extension:ParserFunctions##switch|usage}})||#switch||1.19+
|-
|{{ll|Extension:ParserFunctions|nsp=0}} ({{ll|Help:Extension:ParserFunctions##time|usage}})||#time||1.19+
|-
|{{ll|Extension:AddScriptCss|nsp=0}}||#addscript||Archived
|-
|{{ll|Extension:Arrays|nsp=0}}||#arraydefine||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arraydiff||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arrayindex||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arrayintersect||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arraymerge||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arrayprint||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arrayreset||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arraysearch||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arraysearcharray||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arraysize||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arrayslice||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arraysort||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arraytohash||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arrayunion||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#arrayunique||1.23+
|-
|{{ll|Extension:Arrays|nsp=0}}||#hashtoarray||1.23+
|-
|{{ll|Extension:Attachments|nsp=0}}||#attach||1.31+
|-
|{{ll|Extension:Attachments|nsp=0}}||#exturl||1.31+
|-
|{{ll|Extension:Babel|nsp=0}}||#babel||1.30+
|-
|{{ll|Extension:CSS|nsp=0}}||#css||1.25+
|-
|{{ll|Extension:Coordinate|nsp=0}}||#coordinate||Archived
|-
|{{ll|Extension:Counter|nsp=0}}||#+||1.15+
|-
|{{ll|Extension:Data|nsp=0}}|||#data||Archived
|-
|{{ll|Extension:Data|nsp=0}}|||#sort||Archived
|-
|{{ll|Extension:DynamicFunctions|nsp=0}}|||#arg||Archived
|-
|{{ll|Extension:DynamicFunctions|nsp=0}}|||#ip||Archived
|-
|{{ll|Extension:DynamicFunctions|nsp=0}}|||#rand||Archived
|-
|{{ll|Extension:DynamicFunctions|nsp=0}}|||#skin||Archived
|-
|{{ll|Extension:DynamicPageList (third-party)|nsp=0}}||#dpl||Archived
|-
|{{ll|Extension:DynamicPageList3|nsp=0}}||#dpl||1.39+
|-
|{{ll|Extension:ExpandAfter|nsp=0}}||#expandafter ({{ll|Extension:ExpandAfter#Usage Note|deprecated}}, see: #tag)||Archived
|-
|{{ll|Extension:ForeachFunction|nsp=0}}||#foreachx||Archived
|-
|{{ll|Extension:ForeachFunction|nsp=0}}||#foreachy||Archived
|-
|{{ll|Extension:HasCategory|nsp=0}}||#ifhascat||Archived
|-
|{{ll|Extension:HideNamespace|nsp=0}}||#hidens||Archived
|-
|{{ll|Extension:HideNamespace|nsp=0}}||#unhidens||Archived
|-
|{{ll|Extension:ImageLink|nsp=0}}||#img (old: #imagelink, {{ll|Extension:ImageLink#Usage Note|deprecated}})||Archived
|-
|{{ll|Extension:Infobox Data Capture|nsp=0}}||#dataentry||Archived
|-
|{{ll|Extension:Infobox Data Capture|nsp=0}}||#listsplit||Archived
|-
|{{ll|Extension:InterWikiLinkManager|nsp=0}}||#iwl||Archived
|-
|{{ll|Extension:KeyValue|nsp=0}}||#keyvalue||Archived
|-
|{{ll|Extension:Labeled Section Transclusion|nsp=0}}||#lst||1.25+
|-
|{{ll|Extension:Labeled Section Transclusion|nsp=0}}||#lstx||1.25+
|-
|{{ll|Extension:Labeled Section Transclusion|nsp=0}}||#lsth||1.25+
|-
|{{ll|Extension:LoopFunctions|nsp=0}}||#for||1.23+
|-
|{{ll|Extension:LoopFunctions|nsp=0}}||#foreach||1.25+
|-
|{{ll|Extension:Loops|nsp=0}}||#while||1.25+
|-
|{{ll|Extension:Loops|nsp=0}}||#dowhile||1.25+
|-
|{{ll|Extension:Loops|nsp=0}}||#forargs||1.25+
|-
|{{ll|Extension:Loops|nsp=0}}||#fornumargs||1.25+
|-
|{{ll|Extension:Loops|nsp=0}}||#loop||1.25+
|-
|{{ll|Extension:Maps|nsp=0}}||#geocode||1.27+
|-
|{{ll|Extension:Maps|nsp=0}}||#display_map||1.27+
|-
|{{ll|Extension:Maps|nsp=0}}||#display_point||1.27+
|-
|{{ll|Extension:Maps|nsp=0}}||#coordinates||1.27+
|-
|{{ll|Extension:Maps|nsp=0}}||#distance||1.27+
|-
|{{ll|Extension:MediaFunctions|nsp=0}}||#media..||1.23+
|-
|{{ll|Extension:PageAfterAndBefore|nsp=0}}||#pagebefore||Archived
|-
|{{ll|Extension:PageAfterAndBefore|nsp=0}}||#pageafter||Archived
|-
|{{ll|Extension:PageAfterAndBefore|nsp=0}}||#firstpage||Archived
|-
|{{ll|Extension:PageAfterAndBefore|nsp=0}}||#lastpage||Archived
|-
|{{ll|Extension:PageFunctions|nsp=0}}||#pagetitle||Archived
|-
|{{ll|Extension:PageFunctions|nsp=0}}||#pagesubtitle||Archived
|-
|{{ll|Extension:PageFunctions|nsp=0}}||#pageexists||Archived
|-
|{{ll|Extension:PageFunctions|nsp=0}}||#varset||Archived
|-
|{{ll|Extension:PageFunctions|nsp=0}}||#varget||Archived
|-
|{{ll|Extension:PageFunctions|nsp=0}}||#varcapset||Archived
|-
|{{ll|Extension:PageFunctions|nsp=0}}||#cshow||Archived
|-
|{{ll|Extension:PageFunctions|nsp=0}}||#varaset||Archived
|-
|{{ll|Extension:PageFunctions|nsp=0}}||#varaget||Archived
|-
|{{ll|Extension:ParserFunctions (extended)|nsp=0}}||#expr (extended)||Archived
|-
|{{ll|Extension:ParserFunctions (extended)|nsp=0}}||#ifexpr (extended)||Archived
|-
|{{ll|Extension:ParserFunctions (extended)|nsp=0}}||#min||Archived
|-
|{{ll|Extension:ParserFunctions (extended)|nsp=0}}||#max||Archived
|-
|{{ll|Extension:ParserFunctions (extended)|nsp=0}}||#if||Archived
|-
|{{ll|Extension:ParserFunctions (extended)|nsp=0}}||#ifeq||Archived
|-
|{{ll|Extension:ParserFunctions (extended)|nsp=0}}||#ifexist||Archived
|-
|{{ll|Extension:ParserFunctions (extended)|nsp=0}}||#rel2abs||Archived
|-
|{{ll|Extension:ParserFunctions (extended)|nsp=0}}||#switch||Archived
|-
|{{ll|Extension:ParserFunctions (extended)|nsp=0}}||#time||Archived
|-
|{{ll|Extension:Pipe Escape|nsp=0}}||#!||1.23+
|-
|{{ll|Extension:QPoll|nsp=0}}||#qpuserchoice||Archived
|-
|{{ll|Extension:RegexTools|nsp=0}}||#regex||Archived
|-
|{{ll|Extension:RegexTools|nsp=0}}||#regex_vars||Archived
|-
|{{ll|Extension:Scribunto|nsp=0}}||#invoke||
|-
|{{ll|Extension:SecureProperties|nsp=0}}|||#pg||Archived
|-
|{{ll|Extension:SecureProperties|nsp=0}}|||#ps||Archived
|-
|{{ll|Extension:SecureProperties|nsp=0}}|||#pf||Archived
|-
|{{ll|Extension:SecureProperties|nsp=0}}|||#gg||Archived
|-
|{{ll|Extension:SecureProperties|nsp=0}}|||#gs||Archived
|-
|{{ll|Extension:Semantic MediaWiki|nsp=0}}||#ask||1.27+
|-
|{{ll|Extension:Semantic MediaWiki|nsp=0}}||#concept||1.27+
|-
|{{ll|Extension:Semantic MediaWiki|nsp=0}}||#info||1.27+
|-
|{{ll|Extension:Semantic MediaWiki|nsp=0}}||#show||1.27+
|-
|{{ll|Extension:Semantic MediaWiki|nsp=0}}||#set||1.27+
|-
|{{ll|Extension:StringFunctions|nsp=0}}||#len||1.7+ 
|-
|{{ll|Extension:StringFunctions|nsp=0}}||#pos||1.7+
|-
|{{ll|Extension:StringFunctions|nsp=0}}||#rpos||1.7+
|-
|{{ll|Extension:StringFunctions|nsp=0}}||#sub||1.7+
|-
|{{ll|Extension:StringFunctions|nsp=0}}||#pad||1.7+
|-
|{{ll|Extension:StringFunctions|nsp=0}}||#replace||1.7+
|-
|{{ll|Extension:StringFunctions|nsp=0}}||#explode||1.7+
|-
|{{ll|Extension:StringFunctions|nsp=0}}||#urlencode||1.7+
|-
|{{ll|Extension:StringFunctions|nsp=0}}||#urldecode||1.7+
|-
|{{ll|Extension:TreeAndMenu|nsp=0}}|||#tree||1.23+
|-
|{{ll|Extension:TreeAndMenu|nsp=0}}|||#menu||1.23+
|-
|{{ll|Extension:Variables|nsp=0}}||#vardefine||1.29+
|-
|{{ll|Extension:Variables|nsp=0}}||#vardefineecho||1.29+
|-
|{{ll|Extension:Variables|nsp=0}}||#var||1.29+
|-
|{{ll|Extension:Variables|nsp=0}}||#varexists||1.29+
|-
|{{ll|Extension:Variables|nsp=0}}||#var_final||1.29+
|-
|{{ll|Extension:Wikibase Client|nsp=0}}||#property||
|-
|{{ll|Extension:Wikibase Client|nsp=0}}||#statements||
|-
|}

==See also==
*{{ll|Help:Magic words}}
*{{ll|Category:Parser function extensions}}
*{{ll|Manual:Parser functions|Writing parser functions}} (software development)
* Parser functions for Wikibase (the extensions that enables Wikidata): [[:d:Wikidata:How to use data on Wikimedia projects]]

[[Category:Customization techniques{{#translation:}}|{{PAGENAME}}]]
[[Category:Parser function extensions{{#translation:}}| ]]
[[Category:Extension examples{{#translation:}}| ]]