Help:Extension:ParserFunctions

This page is a translated version of the page Help:Extension:ParserFunctions and the translation is 24% complete.

ParserFunctions uzantısı, MediaWiki'de zaten mevcut olan değişkenlere ek olarak on bir yeni ayrıştırıcı işlev sunar. (Dize işleme için ek ayrıştırıcı işlevleri sağlamak üzere yapılandırılabilir; bu dize işlevleri başka yere belgelenmiştir.) Bu uzantı tarafından sağlanan tüm ayrıştırıcı işlevleri şu şekildedir:

{{#işlevadı: değişken 1 | değişken 2 | değişken 3 ... }}

#expr

Tür Operatörler
Gruplama (parantezler) ( )
Sayılar 1234.5   e (2.718)   pi (3.142)
ikili operatör e   tekli +,-
Tekli not ceil trunc floor abs exp ln sin cos tan acos asin atan
İkili ^
* / div mod
+ -
Yuvarlama round
Mantık = != <> > < >= <=
and
or

Bu işlev, matematiksel bir ifadeyi değerlendirir ve hesaplanan değeri döndürür. Bu işlev, mw.ext.ParserFunctions.expr işlevi aracılığıyla Scribunto olarak da kullanılabilir.

{{#expr: ifade }}

Kullanılabilir operatörler, öncelik sırasına göre sağda listelenir. Her operatörün işleviyle ilgili daha fazla ayrıntı için Help:Hesaplama sayfasına bakın. Döndürülen sonucun doğruluğu ve biçimi, vikiyi çalıştıran sunucunun işletim sistemine ve site dilinin sayı biçimine bağlı olarak değişecektir.

Boole cebri kullanılarak değerlendirme yapılırken, sıfır false olarak değerlendirilir ve pozitif veya negatif herhangi bir sıfır olmayan değer true olarak değerlendirilir:

{{#expr: 1 and -1 }}1
{{#expr: 1 and 0 }}0
{{#expr: 1 or -1 }}1
{{#expr: -1 or 0 }}1
{{#expr: 0 or 0 }}0

Boş bir giriş ifadesi boş bir dize döndürür. Geçersiz ifadeler, #iferror işlevi kullanılarak yakalanabilecek birkaç hata mesajından birini döndürür:

{{#expr: }}
{{#expr: 1+ }}Expression error: Missing operand for +.
{{#expr: 1 = }}Expression error: Missing operand for =.
{{#expr: 1 foo 2 }}Expression error: Unrecognized word "foo".

Bir sayıdan önce veya sonra toplama ve çıkarma işlenenlerinin sırası anlamlıdır ve hatalı girdi içeren bir işlenen yerine pozitif veya negatif bir değer olarak kabul edilebilir:

{{#expr: +1 }}1
{{#expr: -1 }}-1
{{#expr: + 1 }}1
{{#expr: - 1 }}-1

Sihirli kelimelerin çıkışını kullanıyorsanız, virgülleri kaldırmak ve sayıları çevirmek için bunları ham formatlamanız gerektiğini unutmayın. Örneğin, {{NUMBEROFUSERS}}, {{formatnum :{{NUMBEROFUSERS}}|R}} kullanılarak elde edilebilecek 17536396 ile istediğimiz yerde 17.536.396 ile sonuçlanır. Bu, özellikle sayıların çevrildiği bazı dillerde önemlidir. Örneğin, Bengalce'de {{NUMBEROFUSERS}}, ৩০,০৬১ üretir.

{{#expr:{{NUMBEROFUSERS}}+100}} 117.536
{{#expr:{{formatnum:{{NUMBEROFUSERS}}|R}}+100}}17536496
  Uyarı: mod operatörü, ikinci bağımsız değişkenin bazı değerleri için yanlış sonuçlar veriyor:
{{#expr: 123 mod (2^64-1)}}Division by zero. (boş bir dize üretir; 123 olmalı)
Tarihlere dayalı hesaplamalar yapmak istiyorsanız (örneğin, geçerli tarih ve saatin başka bir tarih ve saatten sonra olup olmadığını test edin), önce {{#time: xNU }} kullanarak zamanı 1 Ocak 1970'den sonraki saniye sayısına dönüştürün, ardından basitçe ekleyebilir ve tarihleri sayı olarak çıkarın.

Yuvarlama

Yuvarlaklar soldaki sayıyı bir kuvvete yükseltilmiş 1/10'un katına çıkarır, üs sağda verilen sayının kesik değerine eşittir.

Yukarı veya aşağı yuvarlamak için sırasıyla tekli ceil veya floor kullanın.

Test durumu Sonuç Yuvarlama yöntemi
{{#expr: 1/3 round 5 }} 0.33333 Son rakam < 5 olduğundan belirgin bir yuvarlama oluşmaz (0.333333… → 0.33333)
{{#expr: 1/6 round 5 }} 0.16667 Son rakam ≥ 5 olduğundan yuvarlanır (0.166666… → 0.16667)
{{#expr: 8.99999/9 round 5 }} 1 Yine, sonuç son basamağa yuvarlanır, bu da ek yuvarlama ile sonuçlanır (0.999998… → 1.00000 → 1)
{{#expr: 1234.5678 round -2 }} 1200 Negatif değerler ondalık noktanın soluna yuvarlandığından en yakın 100'e yuvarlanır
{{#expr: 1234.5678 round 2 }} 1234.57 Pozitif değerler ondalık noktanın sağına yuvarlandığından en yakın 100'e yuvarlanır
{{#expr: 1234.5678 round 2.3 }} 1234.57 Yuvarlama dizinindeki ondalık sayılar, yuvarlanan sonuçta hiçbir fark yaratmaz
{{#expr: trunc 1234.5678 }} 1234 Ondalık kısım kesildi (doğranmış)
En yakın tam sayıya yuvarlama
{{#expr: 1/3 round 0 }} 0 Sıfır olan en yakın tamsayıya kadar
{{#expr: 1/2 round 0 }} 1 Bir olan en yakın tamsayıya kadar
{{#expr: 3/4 round 0 }} 1 Bir olan en yakın tamsayıya kadar
{{#expr: -1/3 round 0 }} -0 Sıfır olan en yakın tamsayıya kadar
{{#expr: -1/2 round 0 }} -1 Negatif olan en yakın tam sayıya kadar
{{#expr: -3/4 round 0 }} -1 Negatif olan en yakın tam sayıya kadar
tavan ve zemin ile yukarı veya aşağı yuvarlama
{{#expr: ceil(1/3) }} 1 Bir sonraki daha büyük tam sayıya kadar
{{#expr: floor(1/3) }} 0 Sıfır olan bir sonraki daha küçük tam sayıya kadar
{{#expr: ceil(-1/3) }} -0 Sıfır olan bir sonraki daha büyük tam sayıya kadar
{{#expr: floor(-1/3) }} -1 Negatif olan bir sonraki daha küçük tam sayıya kadar
{{#expr: ceil 1/3 }} 0.33333333333333 1 zaten bir tam sayı olduğundan yuvarlanmaz
  Uyarı: Tahmin edebileceğiniz gibi ceil(1/3) olarak değil, (ceil 1)/3 olarak yorumlandı

Dizeler

İfadeler yalnızca sayı benzeri değerlerle çalışır, dizeleri veya karakterleri karşılaştıramazlar. Bunun yerine #ifeq kullanılabilir.

{{#expr: "a" = "a" }}Expression error: Unrecognized punctuation character """.
{{#expr: a = a }}Expression error: Unrecognized word "a".
{{#ifeq: a | a | 1 | 0 }}1

#if

Bu işlev, bir test dizesini değerlendirir ve boş olup olmadığını belirler. Yalnızca boşluk içeren bir test dizisi boş olarak kabul edilir.

{{#if: test dizesi | test dizisi boş değilse değer | test dizisi boşsa (veya yalnızca beyaz boşluk) değer }}
{{#if: ilk parametre | ikinci parametre | üçüncü parametre }}

Bu işlev, ilk olarak ilk parametrenin boş olup olmadığını test eder. İlk parametre boş değilse, işlev ikinci bağımsız değişkeni görüntüler. İlk parametre boşsa veya yalnızca boşluk karakterleri (boşluklar, yeni satırlar vb.) içeriyorsa, üçüncü bağımsız değişkeni görüntüler.

{{#if: | yes | no}}no
{{#if: string | yes | no}}yes
{{#if:      | yes | no}}no
{{#if:


| yes | no}}
no

Test dizesi her zaman saf metin olarak yorumlanır, bu nedenle matematiksel ifadeler değerlendirilmez:

{{#if: 1==2 | yes | no }}yes
{{#if: 0 | yes | no }}yes

Son parametre (false) atlanabilir:

{{#if: foo | yes }} yes
{{#if: | yes }}
{{#if: foo | | no}}

İşlev iç içe olabilir. Bunu yapmak için, #if işlevinin bir parametresi yerine iç #if işlevini tam biçiminde yuvalayın. Yedi seviyeye kadar iç içe yerleştirme mümkündür, ancak bu vikiye veya bir bellek sınırına bağlı olabilir.

{{#if: test dizesi | test dizesi boş değilse değer |{{#if: test dizesi | test dizesi boş değilse değer | test dizisi boşsa (veya yalnızca beyaz boşluk) değer }} }}
  1. if ifadenizde test dizesi olarak bir parametre de kullanabilirsiniz. Değişken adından sonra | (boru sembolü) eklediğinizden emin olmanız gerekir.

(Böylece parametrenin bir değeri yoksa, "{{{1}}}" dizesi yerine boş bir dize olarak değerlendirilir.)

{{#if:{{{1|}}}|1 değişkeninde metin girdiniz|1 değişkeninde metin yok}}

Bu ayrıştırıcı işlevine ilişkin daha fazla örnek için Help:Şablonlarda ayrıştırıcı işlevler sayfasına bakın.

#ifeq

Bu ayrıştırıcı işlevi, iki giriş dizesini karşılaştırır, özdeş olup olmadıklarını belirler ve sonuca göre iki dizeden birini döndürür. Daha fazla karşılaştırma ve çıkış dizisi gerekiyorsa, #switch kullanmayı düşünün.

{{#ifeq: string 1 | string 2 | value if identical | value if different }}

Her iki dizi de geçerli sayısal değerlerse, diziler sayısal olarak karşılaştırılır:

{{#ifeq: 01 | 1 | equal | not equal}}equal
{{#ifeq: 0 | -0 | equal | not equal}}equal
{{#ifeq: 1e3 | 1000 | equal | not equal}}equal
{{#ifeq: {{#expr:10^3}} | 1000 | equal | not equal}}equal

Aksi hâlde karşılaştırma metin olarak yapılır; bu karşılaştırma büyük/küçük harf duyarlıdır:

{{#ifeq: foo | bar | equal | not equal}}not equal
{{#ifeq: foo | Foo | equal | not equal}}not equal
{{#ifeq: "01" | "1" | equal | not equal}}not equal  (yukarıdaki benzer örnekle tırnak işaretleri olmadan karşılaştırın)
{{#ifeq: 10^3 | 1000 | equal | not equal}}not equal  (yukarıdaki benzer örnekle karşılaştırın, önce #expr geçerli bir sayı döndürür)

Pratik bir örnek olarak, kısa ve uzun olmak üzere iki standart zaman arasında seçim yapmak için ayrıştırıcıyı kullanan mevcut bir Template:Timer şablonu düşünün. "short" dizesiyle karşılaştırılacak ilk giriş olarak parametreyi alır. Sıralama için bir konvansiyon yoktur, ancak parametre önce giderse okunması daha kolaydır. Şablon kodu şu şekilde tanımlanır:

{{#ifeq: {{{1|}}} | short | 20 | 40 }}

aşağıdakiler ortaya çıkar:

{{timer|short}}20
{{timer|20}}40
{{timer}}40
  Uyarı: #ifexpr, #ifeq ve #switch ayrıştırıcılarıyla eşdeğer sayısal karşılaştırmalar bildirmez. Bu son ikisi #ifexpr değerden daha doğrudur ve eşdeğer sonuçlar döndürmez.

Değiştirilen son rakamla bu karşılaştırmayı düşünün:

{{#ifeq: 12345678901234567 | 12345678901234568 | equal | not equal}}not equal
{{#switch: 12345678901234567 | 12345678901234568 = equal | not equal}}not equal

#ifeq ve #switch içinde kullanılan PHP, tamsayı türünde iki sayıyı karşılaştırdığından, beklenen sonucu doğru şekilde döndürür. #ifexpr ve aynı sayılarla:

{{#ifexpr: 12345678901234567 = 12345678901234568 | equal | not equal}}equal

Farklı rakamla, eşittir sonucu aslında yanlıştır.

#ifexpr değerindeki bu davranış, MediaWiki'nin ifadelerdeki değişmez sayıları, bunun gibi büyük tamsayılar için yuvarlamayı içeren float türüne dönüştürmesinden kaynaklanır.


  Uyarı: Bir ayrıştırıcı işlevi içinde kullanıldığında, tüm ayrıştırıcı etiketleri ve diğer ayrıştırıcı işlevleri geçici olarak benzersiz bir kod ile değiştirilmelidir. Bu, karşılaştırmaları etkiler:
{{#ifeq: <nowiki>foo</nowiki> | <nowiki>foo</nowiki> | equal | not equal}}not equal
{{#ifeq: <math>foo</math> | <math>foo</math> | equal | not equal}}not equal
{{#ifeq: {{#tag:math|foo}} | {{#tag:math|foo}} | equal | not equal}}not equal
{{#ifeq: [[foo]] | [[foo]] | equal | not equal}}equal
Karşılaştırılacak dizeler, bu etiketleri içeren aynı şablon için eşit çağrılar olarak verilirse, koşul doğrudur, ancak bu tür etiketleri içeren aynı içeriğe sahip iki şablon olması durumunda yanlıştır.


  Uyarı: Site yapılandırmasına bağlı olarak sayfa-adı sihirli kelimeler ile birebir karşılaştırmalar başarısız olabilir. Örneğin, vikiye bağlı olarak {{FULLPAGENAME}}, ilk harfi büyük yazabilir ve tüm alt çizgileri boşluklarla değiştirir.

Bu sorunu çözmek için sihirli kelimesini her iki parametreye de uygulayın:

{{#ifeq: {{FULLPAGENAME: L'Aquila}} | {{FULLPAGENAME}} | equal | not equal}}equal


#iferror

Bu işlev bir giriş dizesi alır ve iki sonuçtan birini döndürür; giriş dizesi, #expr, #time ve #rel2abs gibi diğer ayrıştırıcı işlevler tarafından oluşturulan $hatalı bir HTML nesnesi içeriyorsa, döngüler ve özyinelemeler gibi şablon hataları varsa, işlev true olarak değerlendirilir, ve diğer "failsoft" ayrıştırıcı hataları.

{{#iferror: test string | value if error | value if correct }}

Dönüş dizelerinden biri veya her ikisi atlanabilir. correct dizesi atlanırsa, hatalı değilse test string döndürülür. error dizesi de atlanırsa, bir hata durumunda boş bir dize döndürülür:

{{#iferror: {{#expr: 1 + 2 }} | error | correct }}correct
{{#iferror: {{#expr: 1 + X }} | error | correct }}error
{{#iferror: {{#expr: 1 + 2 }} | error }}3
{{#iferror: {{#expr: 1 + X }} | error }}error
{{#iferror: {{#expr: 1 + 2 }} }}3
{{#iferror: {{#expr: 1 + X }} }}
{{#iferror: {{#expr: . }} | error | correct }}correct
{{#iferror: <strong class="error">a</strong> | error | correct }}error

#ifexpr

Bu işlev, matematiksel bir ifadeyi değerlendirir ve sonucun boole değerine bağlı olarak iki dizeden birini döndürür:

{{#ifexpr: expression | value if true | value if false }}

expression girişi tam olarak yukarıdaki #expr için olduğu gibi değerlendirilir ve aynı operatörler kullanılabilir. Çıkış daha sonra bir boole ifadesi olarak değerlendirilir.

Boş bir giriş ifadesi false olarak değerlendirilir:

{{#ifexpr: | yes | no}}no

Yukarıda bahsedildiği gibi, sıfır false olarak değerlendirilir ve sıfır olmayan herhangi bir değer true olarak değerlendirilir, bu nedenle bu işlev yalnızca #ifeq ve #expr kullanan bir işleve eşdeğerdir:

{{#ifeq: {{#expr: expression }} | 0 | value if false | value if true }}

boş veya yanlış bir giriş ifadesi dışında (bir hata mesajı boş bir dize olarak değerlendirilir; sıfıra eşit değildir, bu nedenle value if true alırız).

{{#ifexpr: = | yes | no }} Expression error: Unexpected = operator.

karşılama

{{#ifeq: {{#expr: = }} | 0 | no | yes }} yes

Dönüş değerlerinden biri veya her ikisi atlanabilir; uygun dal boş bırakıldığında çıkış verilmez:

{{#ifexpr: 1 > 0 | yes }}yes
{{#ifexpr: 1 < 0 | yes }}
{{#ifexpr: 0 = 0 | yes }} yes
{{#ifexpr: 1 > 0 | | no}}
{{#ifexpr: 1 < 0 | | no}} no
{{#ifexpr: 1 > 0 }}

Boolean operators of equality or inequality operators are supported.

{{#ifexpr: 0 = 0 or 1 = 0 | yes}}yes
{{#ifexpr: 0 = 0 and 1 = 0 | | no}}no

#ifexist

Bu işlev bir giriş dizesi alır, onu sayfa başlığı olarak yorumlar ve sayfanın yerel vikide bulunup bulunmadığına bağlı olarak iki değerden birini döndürür.

{{#ifexist: page title | value if exists | value if doesn't exist }}

Sayfa mevcutsa, içerik barındırıyorsa, görünür şekilde boşsa (kategori bağlantıları veya sihirli kelimeler gibi meta veriler içeriyorsa, ancak görünür bir içerik sayfası yoksa işlev true olarak değerlendirir.), boş veya bir yönlendirme değerlendirilir. Sayfanın önceden var olduğu ancak silindiği de dahil olmak üzere, yalnızca kırmızı bağlantı verilen sayfalar false olarak değerlendirilir.

{{#ifexist: Help:Extension:ParserFunctions/tr | exists | doesn't exist }}exists
{{#ifexist: XXHelp:Extension:ParserFunctions/trXX | exists | doesn't exist }}doesn't exist

İşlev, özelleştirilmiş sistem mesajları ve yazılım tarafından tanımlanan özel sayfalar için true olarak değerlendirilir.

{{#ifexist: Special:Watchlist | exists | doesn't exist }}exists
{{#ifexist: Special:CheckUser | exists | doesn't exist }}exists (çünkü bu vikide Checkuser uzantısı yüklüdür)
{{#ifexist: MediaWiki:Copyright | exists | doesn't exist }}exists (çünkü MediaWiki:Copyright özelleştirildi)

Bir sayfa #ifexist: kullanarak bir hedefi kontrol ederse, o sayfa hedef sayfanın Special:WhatLinksHere listesinde görünür. Dolayısıyla, {{#ifexist:Foo }} kodu bu sayfaya (Help:Extension:ParserFunctions/tr) canlı olarak dahil edildiyse, Special:WhatLinksHere/Foo Help:Extension:ParserFunctions/tr sayfasını listeleyecektir.

Paylaşılan bir medya deposu kullanan wikilerde, bir dosyanın depoya yüklenip yüklenmediğini kontrol etmek için #ifexist: kullanılabilir, ancak vikinin kendisine yüklenmez:

{{#ifexist: File:Example.png | exists | doesn't exist }}doesn't exist
{{#ifexist: Image:Example.png | exists | doesn't exist }}doesn't exist
{{#ifexist: Media:Example.png | exists | doesn't exist }}exists

Dosya için yerel bir açıklama sayfası oluşturulmuşsa, yukarıdakilerin tümü için sonuç var olur.

#ifexist: vikiarası bağlantıları ile çalışmaz.

ifexist sınırları

#ifexist: "zengin bir ayrıştırıcı işlevi" olarak kabul edilir; herhangi bir sayfaya yalnızca sınırlı sayıda dahil edilebilir (yansıtılmış şablonların içindeki işlevler dahil). Bu sınır aşıldığında, hedef sayfa olsun veya olmasın, diğer #ifexist: işlevleri otomatik olarak false döndürür ve sayfa Category:Pages with too many expensive parser function calls olarak sınıflandırılır. İzleme kategorisi adı vikinizin içerik diline göre değişebilir.

Bazı kullanım durumlarında, a.new (var olmayan sayfalara bağlantı seçmek için) veya a:not(.new) (mevcut sayfalara bağlantılar seçmek için) seçicilerini kullanarak css ile ifexist efektini taklit etmek mümkündür. Ayrıca, tek bir sayfada kullanılabilecek zengin ayrıştırıcı işlevlerinin sayısı $wgExpensiveParserFunctionLimit tarafından kontrol edildiğinden, gerekirse LocalSettings.php içindeki limit de artırılabilir.

ifexist ve istenen sayfalar

Mevcut olmayan ve #ifexist kullanımı için test edilen bir sayfa İstenen Sayfalar'da yer alacaktır. Nedeni için görev T14019 ve bir geçici çözüm için w:Template:Linkless exists sayfasına bakın.

#rel2abs

Bu işlev, göreli bir dosya yolunu mutlak bir dosya yoluna dönüştürür.

{{#rel2abs: path }}
{{#rel2abs: path | base path }}

path girişi içinde aşağıdaki sözdizimi geçerlidir:

  • . → mevcut düzey
  • .. → bir düzey yukarı çıkın
  • /foo → /foo alt dizinine bir düzey aşağı inin

base path belirtilmezse, bunun yerine sayfanın tam sayfa adı kullanılacaktır:

{{#rel2abs: /quok | Help:Foo/bar/baz }}Help:Foo/bar/baz/quok
{{#rel2abs: ./quok | Help:Foo/bar/baz }}Help:Foo/bar/baz/quok
{{#rel2abs: ../quok | Help:Foo/bar/baz }}Help:Foo/bar/quok
{{#rel2abs: ../. | Help:Foo/bar/baz }}Help:Foo/bar

/. veya /./ gibi geçersiz sözdizimi yoksayılır. İkiden fazla ardışık nokta izin verilmediğinden, ardışık ifadeleri ayırmak için aşağıdaki gibi diziler kullanılabilir:

{{#rel2abs: ../quok/. | Help:Foo/bar/baz }}Help:Foo/bar/quok
{{#rel2abs: ../../quok | Help:Foo/bar/baz }}Help:Foo/quok
{{#rel2abs: ../../../quok | Help:Foo/bar/baz }}quok
{{#rel2abs: ../../../../quok | Help:Foo/bar/baz }}Error: Invalid depth in path: "Help:Foo/bar/baz/../../../../quok" (tried to access a node above the root node).

#switch

Ayrıca bakınız: w:Help:Switch parser function

This function compares one input value against several test cases, returning an associated string if a match is found.

{{#switch: comparison string
 | case = result
 | case = result
 | ...
 | case = result
 | default result
}}

Examples:

{{#switch: baz | foo = Foo | baz = Baz | Bar }} Baz
{{#switch: foo | foo = Foo | baz = Baz | Bar }} Foo
{{#switch: zzz | foo = Foo | baz = Baz | Bar }} Bar

#switch with partial transclusion tags can affect a configuration file that enables an editor unfamiliar with template coding to view and edit configurable elements.

Default

The default result is returned if no case string matches the comparison string:

{{#switch: test | foo = Foo | baz = Baz | Bar }} Bar

In this syntax, the default result must be the last parameter and must not contain a raw equals sign (an equals sign without {{}}). If it does, it will be treated as a case comparison, and no text will display if no cases match. This is because the default value has not been defined (is empty). If a case matches however, its associated string will be returned.

{{#switch: test | Bar | foo = Foo | baz = Baz }} →
{{#switch: test | foo = Foo | baz = Baz | B=ar }} →
{{#switch: test | test = Foo | baz = Baz | B=ar }} → Foo

Alternatively, the default result may be explicitly declared with a case string of "#default".

{{#switch: comparison string
 | case = result
 | case = result
 | ...
 | case = result
 | #default = default result
}}

Default results declared in this way may be placed anywhere within the function:

{{#switch: test | foo = Foo | #default = Bar | baz = Baz }} Bar

If the default parameter is omitted and no match is made, no result is returned:

{{#switch: test | foo = Foo | baz = Baz }}

Grouping results

It is possible to have 'fall through' values, where several case strings return the same result string. This minimizes duplication.

{{#switch: comparison string
 | case1 = result1
 | case2 
 | case3 
 | case4 = result234
 | case5 = result5
 | case6 
 | case7 = result67
 | #default = default result
}}

Here cases 2, 3 and 4 all return result234; cases 6 and 7 both return result67. The "#default = " in the last parameter may be omitted in the above case.

Use with parameters

The function may be used with parameters as the test string. In this case, it is not necessary to place the pipe after the parameter name, because it is very unlikely that you will choose to set a case to be the string "{{{parameter name}}}". (This is the value the parameter will default to if the pipe is absent and the parameter doesn't exist or have a value. See Help:Şablonlarda ayrıştırıcı işlevler .)

{{#switch: {{{1}}} | foo = Foo | baz = Baz | Bar }}

In the above case, if {{{1}}} equals foo, the function will return Foo. If it equals baz, the function will return Baz. If the parameter is empty or does not exist, the function will return Bar.

As in the section above, cases can be combined to give a single result.

{{#switch: {{{1}}} | foo | zoo | roo = Foo | baz = Baz | Bar }}

Here, if {{{1}}} equals foo, zoo or roo, the function will return Foo. If it equals baz, the function will return Baz. If the parameter is empty or does not exist, the function will return Bar.

Additionally, the default result can be omitted if you do not wish to return anything if the test parameter value does not match any of the cases.

{{#switch: {{{1}}} | foo = Foo | bar = Bar }}

In this case, the function returns an empty string unless {{{1}}} exists and equals foo or bar, in which case it returns Foo or Bar, respectively.

This has the same effect as declaring the default result as empty.

{{#switch: {{{1}}} | foo | zoo | roo = Foo | baz = Baz | }}

If for some reason you decide to set a case as "{{{parameter name}}}", the function will return that case's result when the parameter doesn't exist or doesn't have a value. The parameter would have to exist and have a value other than the string "{{{parameter name}}}" to return the function's default result.

(when {{{1}}} doesn't exist or is empty):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo
(when {{{1}}} has the value "test"):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Bar
(when {{{1}}} has the value "{{{1}}}"):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo


In this hypothetical case, you would need to add the pipe to the parameter ({{{1|}}}).

Comparison behavior

As with #ifeq, the comparison is made numerically if both the comparison string and the case string being tested are numeric; or as a case-sensitive string otherwise:

{{#switch: 0 + 1 | 1 = one | 2 = two | three}} → three
{{#switch: {{#expr: 0 + 1}} | 1 = one | 2 = two | three}} → one
{{#switch: a | a = A | b = B | C}} → A
{{#switch: A | a = A | b = B | C}} → C

A case string may be empty:

{{#switch: | = Nothing | foo = Foo | Something }}Nothing

Once a match is found, subsequent cases are ignored:

{{#switch: b | f = Foo | b = Bar | b = Baz | }}Bar
  Uyarı:

Numerical comparisons with #switch and #ifeq are not equivalent to comparisons in expressions (see also above):

{{#switch: 12345678901234567 | 12345678901234568 = A | B}} → B
{{#ifexpr: 12345678901234567 = 12345678901234568 | A | B}} → A


Raw equal signs

"Case" strings cannot contain raw equals signs. To work around this, create a template {{=}} containing a single equals sign: =, or replace equals sign with html code &#61;.

Example:

You type You get
{{#switch: 1=2
 | 1=2 = raw
 | 1<nowiki>=</nowiki>2 = nowiki
 | 1{{=}}2 = template
 | default
}}
template
{{#switch: 1=2
 | 1&#61;2 = html
 | default
}}
html

For a simple real life example of the use of this function, check Template:NBA color. Two complex examples can be found at Template:Extension and w:Template:BOTREQ.

Replacing #ifeq

#switch can be used to reduce expansion depth.

For example:

  • {{#switch:{{{1}}} |condition1=branch1 |condition2=branch2 |condition3=branch3 |branch4}}

is equivalent to

  • {{#ifeq:{{{1}}}|condition1 |branch1 |{{#ifeq:{{{1}}}|condition2 |branch2 |{{#ifeq:{{{1}}}|condition3 |branch3 |branch4}}}}}}

i.e. deep nesting, linear:

{{#ifeq:{{{1}}}|condition1
  |<!--then-->branch1
  |<!--else-->{{#ifeq:{{{1}}}|condition2
                |<!--then-->branch2
                |<!--else-->{{#ifeq:{{{1}}}|condition3
                              |<!--then-->branch3
                              |<!--else-->branch4}}}}}}

On the other hand, the switch replacement could be complicated/impractical for IFs nested in both branches (shown with alternatives of indentation, indented on both sides), making full symmetrical tree:

{{#ifeq:{{{1}}}|condition1
 |<!--then-->branch1t{{
  #ifeq:{{{1}}}|condition2
   |<!--then-->branch1t2t{{#ifeq:{{{1}}}|condition4|<!--then-->branch1t2t4t|<!--else-->branch1t2t4e}}
   |<!--else-->branch1t2e{{#ifeq:{{{1}}}|condition5|<!--then-->branch1t2e5t|<!--else-->branch1t2e5e}}
  }}
 |<!--else-->branch1e{{#ifeq:{{{1}}}|condition3
   |<!--then-->branch1e3t{{#ifeq:{{{1}}}|condition6|branch1e3t6t|branch1e3t6e}}
   |<!--else-->branch1e3e{{
    #ifeq:{{{1}}}|condition7
     |branch1e3e7t
     |branch1e3e7t
    }}
  }}
}}

#time

This parser function takes a date and/or time (in the Gregorian calendar) and formats it according to the syntax given. A date/time object can be specified; the default is the value of the magic word {{CURRENTTIMESTAMP}} – that is, the time the page was last rendered into HTML.

{{#time: format string }}
{{#time: format string | date/time object }}
{{#time: format string | date/time object | language code }}
{{#time: format string | date/time object | language code | local }}

The list of accepted formatting codes is given in the table to the right. Any character in the formatting string that is not recognized is passed through unaltered; this applies also to blank spaces (the system does not need them for interpreting the codes). There are also two ways to escape characters within the formatting string:

  1. A backslash followed by a formatting character is interpreted as a single literal character
  2. Characters enclosed in double quotes are considered literal characters, and the quotes are removed.

In addition, the digraph xx is interpreted as a single literal "x".

As the list of formatting codes continues to evolve (with the support of new calendars, or of new date fields computed and formatted differently), you should escape all literal characters (not just ASCII letters currently used by formatting codes) that need to be passed through unaltered.

Unfortunately, for now, the ASCII single quote is still not recognized as a simple alternative for marking literal text to the currently supported ASCII double quotes (for example, double quotes are mandatory for in other uses like the delimitation of string values in JSON, C, C++...) and backslashes (which have to be escaped as well in string constants used by many languages, including JSON, C, C++, PHP, JavaScript, Lua). So you still cannot embed any literal double quote without escaping it with a backslash (or you can use other curly, angular or square quotation marks instead).

{{#time: Y-m-d }}2021-10-18
{{#time: [[Y]] m d }}2021 10 18
{{#time: [[Y (year)]] }}2021 (21UTCpmMon, 18 Oct 2021 22:51:09 +0000)
{{#time: [[Y "(year)"]] }}2021 (year)
{{#time: i's" }}51'09"

The date/time object can be in any format accepted by PHP's strtotime() function. Both absolute (eg 20 December 2000) and relative (eg +20 hours) times are accepted.

{{#time: r|now}}Mon, 18 Oct 2021 22:51:10 +0000
{{#time: r|+2 hours}}Tue, 19 Oct 2021 00:51:10 +0000
{{#time: r|now + 2 hours}}Tue, 19 Oct 2021 00:51:10 +0000
{{#time: r|20 December 2000}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|December 20, 2000}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|2000-12-20}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|2000 December 20}}Error: Invalid time.

The language code in ISO 639-3 (?) allows the string to be displayed in the chosen language

{{#time:d F Y|1988-02-28|nl}}28 februari 1988
{{#time:l|now|uk}}понеділок
{{#time:d xg Y|20 June 2010|pl}}20 czerwca 2010

The local parameter specifies if the date/time object refers to the local timezone or to UTC.

This is a boolean parameters: its value is determined by casting the value of the argument (see the official PHP documentation for details on how string are cast to boolean values).

Please note that, if the variable $wgLocaltimezone is set to UTC, there is no difference in the output when local is set to true or false.

See the following examples for details:

{{#time: Y F d H:i:s|now|it|0}}2021 ottobre 18 22:51:10
{{#time: Y F d H:i:s|now|it|1}}2021 ottobre 18 22:51:10
{{#time: Y F d H:i:s|+2 hours||0}}2021 Ekim 19 00:51:10
{{#time: Y F d H:i:s|+2 hours||1}}2021 Ekim 19 00:51:10
{{#time:c|2019-05-16T17:05:43+02:00|it}}2019-05-16T15:05:43+00:00
{{#time:c|2019-05-16T17:05:43+02:00|it|0}}2019-05-16T15:05:43+00:00
{{#time:c|2019-05-16T17:05:43+02:00|it|true}}2019-05-16T15:05:43+00:00

If you've calculated a Unix timestamp, you may use it in date calculations by pre-pending an @ symbol.

{{#time: U | now }}1634597470
{{#time: r | @1634597469 }}Mon, 18 Oct 2021 22:51:09 +0000
  Uyarı:

Without the @ prefix before numeric timestamp values, the result is an error most of the time, or is an unexpected value:

{{#time: r | 1970-01-01 00:16:39 }}Thu, 01 Jan 1970 00:16:39 +0000
{{#time: U | 1970-01-01 00:16:39 }}999
{{#time: r | @999 }}Thu, 01 Jan 1970 00:16:39 +0000 (correct)
{{#time: r | 999 }}Error: Invalid time. (unsupported year format)
{{#time: r | 1970-01-01 00:16:40 }}Thu, 01 Jan 1970 00:16:40 +0000
{{#time: U | 1970-01-01 00:16:40 }}1000
{{#time: r | @1000 }}Thu, 01 Jan 1970 00:16:40 +0000 (correct)
{{#time: r | 1000 }}Sat, 18 Oct 1000 00:00:00 +0000 (interpreted as a year with current month and day of the month)
{{#time: r | 1970-01-01 02:46:39 }}Thu, 01 Jan 1970 02:46:39 +0000
{{#time: U | 1970-01-01 02:46:39 }}9999
{{#time: r | @9999 }}Thu, 01 Jan 1970 02:46:39 +0000 (correct)
{{#time: r | 9999 }}Mon, 18 Oct 9999 00:00:00 +0000 (interpreted as a year with current month and day of the month)
{{#time: r | 1970-01-01 02:46:40 }}Thu, 01 Jan 1970 02:46:40 +0000
{{#time: U | 1970-01-01 02:46:40 }}10000
{{#time: r | @10000 }}Thu, 01 Jan 1970 02:46:40 +0000 (correct)
{{#time: r | 10000 }}Error: Invalid time. (unsupported year format)


  Uyarı:

The range of acceptable input is 1 January 0111 → 31 December 9999. For the years 100 through 110 the output is inconsistent, Y and leap years are like the years 100-110, r, D, l and U are like interpreting these years as 2000-2010.

{{#time: d F Y | 29 Feb 0100 }}01 Mart 0100
(correct, no leap year), but
{{#time: r | 29 Feb 0100 }}Mon, 01 Mar 0100 00:00:00 +0000 (wrong, even if 100 is interpreted as 2000, because that is a leap year)
{{#time: d F Y | 15 April 10000 }}Error: Invalid time.
{{#time: r | 10000-4-15 }}Sat, 15 Apr 2000 10:00:00 +0000

Year numbers 0-99 are interpreted as 2000-2069 and 1970-1999, except when written in 4-digit format with leading zeros:

{{#time: d F Y | 1 Jan 6 }}01 Ocak 2006
{{#time: d F Y | 1 Jan 06 }}01 Ocak 2006
{{#time: d F Y | 1 Jan 006 }}01 Ocak 2006
{{#time: d F Y | 1 Jan 0006 }}01 Ocak 0006 (4-digit format)

The weekday is supplied for the years 100-110 and from 1753, for the years 111-1752 the r-output shows "Unknown" and the l-output "<>". As a consequence, the r-output is not accepted as input for these years.


Full or partial absolute dates can be specified; the function will "fill in" parts of the date that are not specified using the current values:

{{#time: Y | January 1 }}2021
  Uyarı:

The fill-in feature is not consistent; some parts are filled in using the current values, others are not:

{{#time: Y m d H:i:s | June }}2021 06 18 00:00:00 Gives the start of the day, but the current day of the month and the current year.
{{#time: Y m d H:i:s | 2003 }}2003 10 18 00:00:00 Gives the start of the day, but the current day of the year.

There's exception case of the filled day:

{{#time: Y m d H:i:s | June 2003 }}2003 06 01 00:00:00 Gives the start of the day and the start of the month.


A four-digit number is always interpreted as a year, never as hours and minutes:[1]

{{#time: Y m d H:i:s | 1959 }}1959 10 18 00:00:00

A six-digit number is interpreted as hours, minutes and seconds if possible, but otherwise as an error (not, for instance, a year and month):

{{#time: Y m d H:i:s | 195909 }}2021 10 18 19:59:09 Input is treated as a time rather than a year+month code.
{{#time: Y m d H:i:s | 196009 }}Error: Invalid time. Although 19:60:09 is not a valid time, 196009 is not interpreted as September 1960.

The function performs a certain amount of date mathematics:

{{#time: d F Y | January 0 2008 }}31 Aralık 2007
{{#time: d F | January 32 }}Error: Invalid time.
{{#time: d F | February 29 2008 }}29 Şubat
{{#time: d F | February 29 2007 }}01 Mart
{{#time:Y-F|now -1 months}}2021-Eylül

The total length of the format strings of the calls of #time is limited to 6000 characters[2].

Time Zone issue

There is a bug in this #time parser function (more specifically in PHP DateTime) that does not allow the passing-in of non-integers as relative time zone offsets. This issue does not apply when using an on-the-hour time zone, such as EDT. For example:

  • {{#time:g:i A | -4 hours }} → 6:51 PM

However, India is on a +5.5 hours time offset from UTC, and thus using its time zone will not normally allow the correct calculation of a relative time zone offset. Here's what happens:

  • {{#time:g:i A | +5.5 hours }} → 10:51 PM

To workaround this issue, simply convert the time into minutes or seconds, like this:

  • {{#time:g:i A | +330 minutes }} → 4:21 AM
  • {{#time:g:i A | +19800 seconds }} → 4:21 AM

(Tim Starling, the developer of this function, provided the exact syntax for this solution.)

#timel

This function is identical to {{#time: ... }}, when the local parameter is set to true, so it always uses the local time of the wiki (as set in $wgLocaltimezone ).

Syntax of the function is:

{{#timel: format string }}
{{#timel: format string | date/time object }}
{{#timel: format string | date/time object | language code }}
Please note that, if the variable $wgLocaltimezone is set to UTC, there is no difference in the output when local is set to true or false
 
Example of the use of #time and #timel parser functions from a server where the timezone is not UTC

For instance, see the following examples:

{{#time:c|now|it}}2021-10-18T22:51:10+00:00
{{#time:c|now|it|0}}2021-10-18T22:51:10+00:00
{{#time:c|now|it|1}}2021-10-18T22:51:10+00:00
{{#timel:c|now|it}}2021-10-18T22:51:10+00:00
 
Warning Example from https://no.wikipedia.org/wiki/Maldiskusjon:Sommertid
  Uyarı:

Be aware that U for both time and timel will return the same number of seconds since 1970-01-01 00:00:00 UTC on Wikipedias with different timezones than UTC (formerly known as GMT)

U Unix time. Seconds since January 1 1970 00:00:00 GMT.
Z Timezone offset in seconds.
{{#time: U}}1634597469
{{#timel: U}}1634597469
{{#time: Z}}0
{{#timel: Z}}0


#titleparts

This function separates a page title into segments based on slashes, then returns some of those segments as output.

{{#titleparts: pagename | number of segments to return | first segment to return }}

If the number of segments to return parameter is not specified, it defaults to "0", which returns all the segments from the first segment to return (included). If the first segment to return parameter is not specified or is "0", it defaults to "1":

{{#titleparts: Talk:Foo/bar/baz/quok }}Talk:Foo/bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | 1 }}Talk:Foo See also {{ROOTPAGENAME }}.
{{#titleparts: Talk:Foo/bar/baz/quok | 2 }}Talk:Foo/bar
{{#titleparts: Talk:Foo/bar/baz/quok | 2 | 2 }}bar/baz
{{#titleparts: Talk:Foo/bar/baz/quok | | 2 }}bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | | 5 }}

Negative values are accepted for both values. Negative values for the number of segments to return parameter effectively 'strips' segments from the end of the string. Negative values for the first segment to return translates to "start with this segment counting from the right":

{{#titleparts: Talk:Foo/bar/baz/quok | -1 }}Talk:Foo/bar/baz Strips one segment from the end of the string. See also {{BASEPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -4 }} Strips all 4 segments from the end of the string
{{#titleparts: Talk:Foo/bar/baz/quok | -5 }} Strips 5 segments from the end of the string (more than exist)
{{#titleparts: Talk:Foo/bar/baz/quok | | -1 }} quok Returns last segment. See also {{SUBPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | 2 }} bar/baz Strips one segment from the end of the string, then returns the second segment and beyond
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | -2 }} baz Start copying at the second last element; strip one segment from the end of the string

Before processing, the pagename parameter is HTML-decoded: if it contains some standard HTML character entities, they will be converted to plain characters (internally encoded with UTF-8, i.e. the same encoding as in the MediaWiki source page using this parser function).

For example, any occurrence of &quot;, &#34;, or &#x22; in pagename will be replaced by ".
No other conversion from HTML to plain text is performed, so HTML tags are left intact at this initial step even if they are invalid in page titles.

Some magic keywords or parser functions of MediaWiki (such as {{PAGENAME }} and similar) are known to return strings that are needlessly HTML-encoded, even if their own input parameter was not HTML-encoded:

The titleparts parser function can then be used as a workaround, to convert these returned strings so that they can be processed correctly by some other parser functions also taking a page name in parameter (such as {{PAGESINCAT: }} but which are still not working properly with HTML-encoded input strings.

For example, if the current page is Category:Côte-d'Or, then:

  • {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d'Or | 1 | 0 }}, and {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d&apos;Or | 1 | 0 }} are both returning 1; (the #ifeq parser function does perform the HTML-decoding of its input parameters).
  • {{#switch: {{FULLPAGENAME}} | Category:Côte-d'Or = 1 | #default = 0 }}, and {{#switch: {{FULLPAGENAME}} | Category:Côte-d&apos;Or = 1 | #default = 0 }} are both returning 1; (the #switch parser function does perform the HTML-decoding of its input parameters).
  • {{#ifexist: {{FULLPAGENAME}} | 1 | 0 }}, {{#ifexist: Category:Côte-d'Or | 1 | 0 }}, or even {{#ifexist: Category:Côte-d&apos;Or | 1 | 0 }} will all return 1 if that category page exists (the #ifexist parser function does perform the HTML-decoding of its input parameters);
  • {{PAGESINCAT: Côte-d'Or }} will return a non-zero number, if that category contains pages or subcategories, but:
  • {{PAGESINCAT: {{CURRENTPAGENAME}} }}, may still unconditionally return 0, just like:
  • {{PAGESINCAT: {{PAGENAME|Category:Côte-d'Or}} }}
  • {{PAGESINCAT: {{PAGENAME|Category:Côte-d&apos;Or}} }}

The reason of this unexpected behavior is that, with the current versions of MediaWiki, there are two caveats:

  • {{FULLPAGENAME}}, or even {{FULLPAGENAME|Côte-d'Or}} may return the actually HTML-encoded string Category:Côte-d&apos;Or and not the expected Category:Côte-d'Or, and that:
  • {{PAGESINCAT: Côte-d&apos;Or }} unconditionally returns 0 (the PAGESINCAT magic keyword does not perform any HTML-decoding of its input parameter).

The simple workaround using titleparts (which will continue to work if the two caveats are fixed in a later version of MediaWiki) is:

  • {{PAGESINCAT: {{#titleparts: {{CURRENTPAGENAME}} }} }}
  • {{PAGESINCAT: {{#titleparts: {{PAGENAME|Category:Côte-d'Or}} }} }}
  • {{PAGESINCAT: {{#titleparts: {{PAGENAME|Category:Côte-d&apos;Or}} }} }}, that all return the actual number of pages in the same category.

Then the decoded pagename is canonicalized into a standard page title supported by MediaWiki, as much as possible:

  1. All underscores are automatically replaced with spaces:
    {{#titleparts: Talk:Foo/bah_boo|1|2}}bah boo Not bah_boo, despite the underscore in the original.
  2. The string is split a maximum of 25 times; further slashes are ignored and the 25th element will contain the rest of the string. The string is also limited to 255 characters, as it is treated as a page title:
    {{#titleparts: a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/aa/bb/cc/dd/ee | 1 | 25 }}y/z/aa/bb/cc/dd/ee
    If for whatever reason you needed to push this function to its limit, although very unlikely, it is possible to bypass the 25 split limit by nesting function calls:
    {{#titleparts: {{#titleparts: a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/aa/bb/cc/dd/ee| 1 | 25 }} | 1 | 2}}z
  3. Finally the first substring is capitalized according to the capitalization settings of the local wiki (if that substring also starts by a local namespace name, that namespace name is also normalized).
    {{#titleparts: talk:a/b/c }}Talk:A/b/c
  Uyarı:

You can use #titleparts as a small "string parser and converter", but consider that it returns the first substring capitalized:

{{#titleparts: one/two/three/four|1|1 }}One
{{#titleparts: one/two/three/four|1|2 }}two

If lower case is needed, use lc: function to control output:

{{lc: {{#titleparts: one/two/three/four|1|1 }} }}one

You can prepend a 'dummy' slash at the beginning of the string to get the correct first substring capitalization (uppercase or lowercase). Use 2 instead of 1 for first segment to return:

{{#titleparts: /one/two/three/four|1|2 }}one
{{#titleparts: /One/two/three/four|1|2 }}One


  Uyarı:

Certain characters that are illegal in a page title will cause #titleparts to not parse the string:

{{#titleparts: {one/two} | 1 | 1 }}{one/two}. Does not produce the expected: {one
{{#titleparts: [[page]]/123 | 1 | 2 }}page/123. Does not work because brackets are illegal in page titles and this parser function does not process links embedded in its input pagename parameter, even when they use the MediaWiki syntax, or any other HTML or MediaWiki tags.
{{#titleparts: red/#00FF00/blue | 1 | 3 }} → "". Does not work because "#" is also illegal in page titles.


  Uyarı:

If any part of the title is just "." or "..", #titleparts will not parse the string:

{{#titleparts: one/./three | 1 | 1 }}one/./three. The whole string is returned. It does not produce the expected: one


  Uyarı: This function does not degrade gracefully if the input exceeds 255 bytes in UTF-8. If the input string is 256 bytes or more, the whole string is returned.


StringFunctions

All of these functions (len, pos, rpos, sub, replace, explode) are integrated from the StringFunctions extension, but are only available if an administrator sets $wgPFEnableStringFunctions = true; in LocalSettings.php.

All of these functions operate in O(n) time complexity, making them safe against DoS attacks.

  1. Some parameters of these functions are limited through global settings to prevent abuse.
See section Limits hereafter.
  1. For functions that are case sensitive, you may use the magic word {{lc:string}} as a workaround in some cases.
  1. To determine whether a MediaWiki server enables these functions, check the list of supported Extended parser functions in Special:Version.
  1. String length is limited by $wgPFStringLengthLimit variable, default to 1000.

#len

The #len parser function was merged from the StringFunctions extension as of version 1.2.0.

The #len function returns the length of the given string. The syntax is:

{{#len:string}}

The return value is always a number of characters in the source string (after expansions of template invocations, but before conversion to HTML). If no string is specified, the return value is zero.

  • This function is safe with UTF-8 multibyte characters.
Example:
    • {{#len:Žmržlina}}8
  • Leading and trailing spaces or newlines are not counted, but intermediate spaces and newlines are taken into account.
Examples:
    • {{#len:Icecream }}8
    • {{#len: a   b }}5 - 3 spaces between 2 characters
  • Characters given by reference are not converted, but counted according to their source form.
    • {{#len:&nbsp;}}6 - named characters references
    • {{#len:&#32;}}5 - numeric characters references, not ignored despite it designates a space here.
  • Tags such as ‎<nowiki> and other tag extensions will always have a length of zero, since their content is hidden from the parser.
Example:
    • {{#len:<nowiki>This is a </nowiki>test}}4

#pos

The #pos parser function was merged from the StringFunctions extension as of version 1.2.0.

The #pos function returns the position of a given search term within the string. The syntax is:

{{#pos:string|search term|offset}}

The offset parameter, if specified, tells a starting position where this function should begin searching.

If the search term is found, the return value is a zero-based integer of the first position within the string.

If the search term is not found, the function returns an empty string.

  • This function is case sensitive.
  • This function is safe with UTF-8 multibyte characters.
Example: {{#pos:Žmržlina|žlina}} returns 3.
  • As with #len, ‎<nowiki> and other tag extensions are treated as having a length of 1 for the purposes of character position.
Example: {{#pos:<nowiki>This is a </nowiki>test|test}} returns 1.

#rpos

The #rpos parser function was merged from the StringFunctions extension as of version 1.2.0.

The #rpos function returns the last position of a given search term within the string. The syntax is:

 {{#rpos:string|search term}}

If the search term is found, the return value is a zero-based integer of its last position within the string.

If the search term is not found, the function returns -1.

When using this to search for the last delimiter, add +1 to the result to retrieve position after the last delimiter. This also works when the delimiter is not found, because "-1 + 1" is zero, which is the beginning of the given value.
  • This function is case sensitive.
  • This function is safe with UTF-8 multibyte characters.
Example: {{#rpos:Žmržlina|lina}} returns 4.
  • As with #len, ‎<nowiki> and other tag extensions are treated as having a length of 1 for the purposes of character position.
Example: {{#rpos:<nowiki>This is a </nowiki>test|test}} returns 1.

#sub

The #sub parser function was merged from the StringFunctions extension as of version 1.2.0.

The #sub function returns a substring from the given string. The syntax is:

{{#sub:string|start|length}}

The start parameter, if positive (or zero), specifies a zero-based index of the first character to be returned.

Example: {{#sub:Icecream|3}} returns cream.

{{#sub:Icecream|0|3}} returns Ice.

If the start parameter is negative, it specifies how many characters from the end should be returned.

Example: {{#sub:Icecream|-3}} returns eam.

The length parameter, if present and positive, specifies the maximum length of the returned string.

Example: {{#sub:Icecream|3|3}} returns cre.

If the length parameter is negative, it specifies how many characters will be omitted from the end of the string.

Example: {{#sub:Icecream|3|-3}} returns cr.

If the start parameter is negative, it specifies how many characters from the end should be returned. The length parameter, if present and positive, specifies the maximum length of the returned string from the starting point.

Example: {{#sub:Icecream|-3|2}} returns ea.

  • If the length parameter is zero, it is not used for truncation at all.
    • Example: {{#sub:Icecream|3|0}} returns cream. {{#sub:Icecream|0|3}} returns Ice.
  • If start denotes a position beyond the truncation from the end by negative length parameter, an empty string will be returned.
    • Example: {{#sub:Icecream|3|-6}} returns an empty string.
  • This function is safe with UTF-8 multibyte characters.
Example: {{#sub:Žmržlina|3}} returns žlina.
  • As with #len, ‎<nowiki> and other tag extensions are treated as having a length of 1 for the purposes of character position.
Example: {{#sub:<nowiki>This is a </nowiki>test|1}} returns test.

#count

The #count parser function was added to the StringFunctions extension as of version 1.2.0.

The #count function returns the number of times a given substring appears within the provided text.

{{#count:string|substring}}

#replace

The #replace parser function was merged from the StringFunctions extension as of version 1.2.0.

The #replace function returns the given string with all occurrences of a search term replaced with a replacement term.

{{#replace:string|search term|replacement term}}

If the search term is unspecified or empty, a single space will be searched for.

If the replacement term is unspecified or empty, all occurrences of the search term will be removed from the string.

  • This function is case-sensitive.
  • Even if the replacement term is a space, an empty string is used.
This is a side-effect of the MediaWiki parser. To use a space as the replacement term, put it in nowiki tags.
    • Example: {{#replace:My_little_home_page|_|<nowiki> </nowiki>}} returns My little home page.
    • If this doesn't work, try {{#replace:My_little_home_page|_|<nowiki/> <nowiki/>}} with two self-closing tags.
    • Note that this is the only acceptable use of nowiki in the replacement term, as otherwise nowiki could be used to bypass $wgStringFunctionsLimitReplace, injecting an arbitrarily large number of characters into the output.
For this reason, all occurrences of ‎<nowiki> or any other tag extension within the replacement term are replaced with spaces.
  • This function is safe with UTF-8 multibyte characters.
Example: {{#replace:Žmržlina|ž|z}} returns Žmrzlina.
  • If multiple items in a single text string need to be replaced, one could also consider Extension:ReplaceSet .
It adds a parser function for a sequence of replacements.
Case-insensitive replace

Currently the syntax doesn't provide a switch to toggle case-sensitivity setting. But you may make use of magic words of formatting as a workaround. (e.g. {{lc:your_string_here}}) For example, if you want to remove the word "Category:" from the string regardless of its case, you may type:

{{#replace:{{lc:{{{1}}}}}|category:|}}

But the disadvantage is that the output will become all lower-case. If you want to keep the casing after replacement, you have to use multiple nesting levels (i.e. multiple replace calls) to achieve the same thing.

#explode

The #explode parser function was merged from the StringFunctions extension as of version 1.2.0.

The #explode function splits the given string into pieces and then returns one of the pieces. The syntax is:

{{#explode:string|delimiter|position|limit}}

The delimiter parameter specifies a string to be used to divide the string into pieces. This delimiter string is then not part of any piece, and when two delimiter strings are next to each other, they create an empty piece between them. If this parameter is not specified, a single space is used. The limit parameter is available in ParserFunctions only, not the standalone StringFunctions version, and allows you to limit the number of parts returned, with all remaining text included in the final part.

The position parameter specifies which piece is to be returned. Pieces are counted from 0. If this parameter is not specified, the first piece is used (piece with number 0). When a negative value is used as position, the pieces are counted from the end. In this case, piece number -1 means the last piece. Examples:

  • {{#explode:And if you tolerate this| |2}} returns you
  • {{#explode:String/Functions/Code|/|-1}} returns Code
  • {{#explode:Split%By%Percentage%Signs|%|2}} returns Percentage
  • {{#explode:And if you tolerate this| |2|3}} returns you tolerate this

The return value is the position-th piece. If there are fewer pieces than the position specifies, an empty string is returned.

  • This function is case sensitive.
  • The maximum allowed length of the delimiter is limited through $wgStringFunctionsLimitSearch global setting.
  • This function is safe with UTF-8 multibyte characters. Example: {{#explode:Žmržlina|ž|1}} returns lina.

#urldecode

#urldecode converts the escape characters from an 'URL encoded' string string back to readable text. The syntax is:

{{#urldecode:value}}

Notes:

  • This function works by directly exposing PHP's urldecode() function.
  • A character-code-reference can be found at www.w3schools.com.
  • The opposite, urlencode, has been integrated into MediaWiki as of version 1.18; for examples, see Help:Magic Words .
  • urldecode was merged from Stringfunctions in 2010, by commit 1b75afd18d3695bdb6ffbfccd0e4aec064785363

Limits

This module defines three global settings:

These are used to limit some parameters of some functions to ensure the functions operate in O(n) time complexity, and are therefore safe against DoS attacks.

$wgStringFunctionsLimitSearch

This setting is used by #pos, #rpos, #replace, and #explode. All these functions search for a substring in a larger string while they operate, which can run in O(n*m) and therefore make the software more vulnerable to DoS attacks. By setting this value to a specific small number, the time complexity is decreased to O(n).

This setting limits the maximum allowed length of the string being searched for.

The default value is 30 multibyte characters.

$wgStringFunctionsLimitReplace

This setting is used by #replace. This function replaces all occurrences of one string for another, which can be used to quickly generate very large amounts of data, and therefore makes the software more vulnerable to DoS attacks. This setting limits the maximum allowed length of the replacing string.

The default value is 30 multibyte characters.

General points

Substitution

Parser functions can be substituted by prefixing the hash character with subst::

{{subst:#ifexist: Help:Extension:ParserFunctions/tr | [[Help:Extension:ParserFunctions/tr]] | Help:Extension:ParserFunctions/tr }}the code [[Help:Extension:ParserFunctions/tr]] will be inserted in the wikitext since the page Help:Extension:ParserFunctions/tr exists.
  Uyarı:

The results of substituted parser functions are undefined if the expressions contain unsubstituted volatile code such as variables or other parser functions. For consistent results, all the volatile code in the expression to be evaluated must be substituted. See Help:Substitution.


Substitution does not work within ‎<ref>‎</ref> ; you can use {{subst:#tag:ref|}} for this purpose.

Redirects

Especially {{#time:…|now-…}} could be handy in redirects to pages including dates, but this does not work.

Escaping pipe characters in tables

Parser functions will mangle wikitable syntax and pipe characters (|), treating all the raw pipe characters as parameter dividers. To avoid this, most wikis used a template Template:! with its contents only a raw pipe character (|), since MW 1.24 a {{!}} magic word replaced this kludge. This 'hides' the pipe from the MediaWiki parser, ensuring that it is not considered until after all the templates and variables on a page have been expanded. It will then be interpreted as a table row or column separator. Alternatively, raw HTML table syntax can be used, although this is less intuitive and more error-prone.

You can also escape the pipe character for display as a plain, uninterpreted character using an HTML entity: &#124; .

Description You type You get
Escaping pipe character as table row/column separator
{{!}}
|
Escaping pipe character as a plain character
&#124;
|


Stripping whitespace

Whitespace, including newlines, tabs, and spaces, is stripped from the beginning and end of all the parameters of these parser functions. If this is not desirable, comparison of strings can be done after putting them in quotation marks.

{{#ifeq: foo           |           foo | equal | not equal }}equal
{{#ifeq: "foo          " | "          foo" | equal | not equal }}not equal

To prevent the trimming of then and else parts, see m:Template:If. Some people achieve this by using <nowiki > </nowiki> instead of spaces.

foo{{#if:|| bar }}foofoobarfoo
foo{{#if:||<nowiki /> bar <nowiki />}}foofoo bar foo

However, this method can be used to render a single whitespace character only, since the parser squeezes multiple whitespace characters in a row into one.

<span style="white-space: pre;">foo{{#if:||<nowiki/>      bar      <nowiki/>}}foo</span>
foo bar foo

In this example, the white-space: pre style is used to force the whitespace to be preserved by the browser, but even with it the spaces are not shown. This happens because the spaces are stripped by the software, before being sent to the browser.

It is possible to workaround this behavior replacing whitespaces with &#32; (breakable space) or &nbsp; (non-breakable space), since they are not modified by the software:

<span style="white-space: pre;">foo{{#if:||&#32;&#32;&#32;bar&#32;&#32;&#32;}}foo</span>foo bar foo
foo{{#if:||&nbsp;&nbsp;&nbsp;bar&nbsp;&nbsp;&nbsp;}}foofoo   bar   foo

See also

References

  1. Prior to r86805 in 2011 this was not the case.
  2. ParserFunctions.php at phabricator.wikimedia.org