Trợ giúp:Tiện ích mở rộng:ParserFunctions

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

Outdated translations are marked like this.

Tiện mở rộng ParserFunctions cung cấp thêm 11 hàm phân tích cú pháp (parser functions, sau đây gọi ngắn gọn là hàm phân tích), bổ sung cho "các từ thần chú " đã có sẵn trong MediaWiki. (Ngoài ra, lập trình viên có thể thiết lập để bổ sung thêm các hàm phân tích khác nữa dành cho việc xử lí xâu kí tự; những hàm này được miêu tả tại đây .) Tất cả các hàm phân tích cung cấp bởi phần mở rộng này đều có dạng:

{{#tên_hàm: đối số 1 | đối số 2 | đối số 3 ... }}

Lưu ý: Khi bạn sửa đổi trang này, bạn đồng ý phát hành đóng góp của bạn theo giấy phép CC0. Xem trang trợ giúp cộng đồng để biết thêm.

#expr

Loại	Toán tử
Nhóm (dấu ngoặc)	`( )`
Số	`1234.5` `e` (2.718) `pi` (3.142)
	toán tử nhị phân `e` đơn phân `+`,`-`
Đơn phân	`not ceil trunc floor abs exp ln sin cos tan acos asin atan sqrt`
Nhị phân	`^`
	`* / div mod fmod`
	`+ -`
Làm tròn	`round`
Logic	`= != <> > < >= <=`
	`and`
	`or`

Hàm này thực hiện biểu thức toàn học và trả về giá trị nó tính được. Hàm này cũng có sẵn trong Scribunto thông qua hàm mw.ext.ParserFunctions.expr.

{{#expr: biểu thức }}

Basic example

{{#expr: 1 + 1 }} → 2

Các toán tử được liệt kê ở bên phải, theo thứ tự ưu tiên thực hiện. Xem [[Manual:Expr parser function syntax |Trợ giúp:Tính toán]] để biết chi tiết về chức năng của mỗi toán tử. Mức độ chính xác và cách định dạng của kết quả trả về phụ thuộc vào hệ điều hành của máy chủ chạy wiki, và cách định dạng số của ngôn ngữ của trang web đó. The accuracy and format of the result returned will vary depending on the operating system of the server running the wiki and the number format of the site language.

Khi tính toán sử dụng đại số Boole, giá trị không (0) trả về false và bất kì giá trị nào khác không, kể cả âm hay dương, trả về true:

{{#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

Nhập vào một biểu thức trống sẽ trả về một xâu kí tự rỗng. Nhập vào một biểu thức không hợp lệ sẽ trả về một thông báo lỗi, các thông báo lỗi có thể được nhận ra dùng hàm #iferror:

{{#expr: }} →

{{#expr: 1+ }} → Expression error: Missing operand for +.

{{#expr: 1 = }} → Expression error: Missing operand for =.

{{#expr: 1 foo 2 }} → Expression error: Unrecognized word "foo".

Thứ tự của các toán hạng cộng trừ trước hoặc sau một số có ý nghĩa và có thể được xử lý như một giá trị dương hoặc âm thay vì một toán hạng với đầu vào sai.

{{#expr: +1 }} → 1

{{#expr: -1 }} → -1

{{#expr: + 1 }} → 1

{{#expr: - 1 }} → -1

Lưu ý, nếu sử dụng kết quả của các từ khóa đặc biệt (magic words), bạn cần định dạng lại chúng ở dạng thô để loại bỏ dấu phẩy và dịch các chữ số. Ví dụ, {{NUMBEROFUSERS}} cho kết quả là 18.021.584, trong khi chúng ta cần 18021584. Để đạt được điều này, bạn có thể sử dụng {{formatnum :{{NUMBEROFUSERS}}|R}}. Điều này rất quan trọng trong một số ngôn ngữ có chữ số được dịch ra theo ký tự riêng của ngôn ngữ đó. Ví dụ, trong tiếng Bengali, {{NUMBEROFUSERS}} sẽ cho ra ৩০,০৬১.

{{#expr:{{NUMBEROFUSERS}}+100}} → 118.021

{{#expr:{{formatnum:{{NUMBEROFUSERS}}|R}}+100}} → 18021684

Cảnh báo:

Toán tử mod cho kết quả sai đối với một số giá trị của đối số thứ hai

{{#expr: 123 mod (2^64-1)}} → Division by zero. (trả về một xâu rỗng; đáng lẽ ra phải là 123)

Nếu bạn muốn thực hiện các phép toán trên ngày tháng (VD: kiểm tra xem một ngày này là trước hay sau so với ngày kia), trước tiên hãy chuyển đổi ngày, giờ đó sang số giây kể từ 1 tháng 1 năm 1970 sử dụng {{#time: xNU }}, sau đó thực hiện các phép toán như đối với các số.

Làm tròn số

Làm tròn số bên trái đến bội số của 1/10 nâng lên một lũy thừa, với số mũ bằng giá trị nguyên của số bên phải.

Để chủ động làm tròn lên hoặc xuống, sử dụng lần lượt ceil hoặc floor.

Trường hợp kiểm thử Kết quả Cách làm tròn

{{#expr: 1/3 round 5 }} 0.33333 Chữ số cuối cùng < 5, vì thế phép làm tròn không tạo ra thay đổi nào (0.333333… → 0.33333)

{{#expr: 1/6 round 5 }} 0.16667 Chữ số cuối cùng >= 5, vì thế được làm tròn lên (0.166666… → 0.16667)

{{#expr: 8.99999/9 round 5 }} 1 Một lần nữa, chữ số cuối cùng được làm tròn lên, dẫn đến việc các chữ số tiếp theo liên tiếp được làm tròn (0.999998… → 1.00000 → 1)

{{#expr: 1234.5678 round -2 }} 1200 Làm tròn đến hàng trăm (100) vì giá trị âm làm tròn về phía bên trái dấu phẩy

{{#expr: 1234.5678 round 2 }} 1234.57 Làm tròn đến hàng phần trăm (0.01) vì giá trị dương làm tròn về phía bên phải dấu phẩy

{{#expr: 1234.5678 round 2.3 }} 1234.57 Phần thập phân trong số làm tròn không ảnh hưởng đến kết quả phép làm tròn

{{#expr: trunc 1234.5678 }} 1234 Phần thập phân bị bỏ đi (chặt vứt đi)

Làm tròn đến số nguyên gần nhất

{{#expr: 1/3 round 0 }} 0 Xuống đến số nguyên "gần nhất", ở đây là 0

{{#expr: 1/2 round 0 }} 1 Lên đến số nguyên gần nhất, ở đây là 1

{{#expr: 3/4 round 0 }} 1 Lên đến số nguyên gần nhất, ở đây là 1

{{#expr: -1/3 round 0 }} -0 Lên đến số nguyên gần nhất, ở đây là 0

{{#expr: -1/2 round 0 }} -1 Xuống đến số nguyên gần nhất, ở đây là âm 1

{{#expr: -3/4 round 0 }} -1 Xuống đến số nguyên gần nhất, ở đây là âm 1

Làm tròn lên hoặc xuống với toán tử "ceil" và "floor" ("trần nhà" và "sàn nhà")

{{#expr: ceil(1/3) }} 1 Lên đến số nguyên tiếp sau, ở đây là 1

{{#expr: floor(1/3) }} 0 Xuống đến số nguyên ngay trước nó, ở đây là 0

{{#expr: ceil(-1/3) }} -0 Lên đến số nguyên tiếp sau, ở đây là 0

{{#expr: floor(-1/3) }} -1 Xuống đến số nguyên ngay trước, ở đây là âm 1

{{#expr: ceil 1/3 }}

0.33333333333333

Không được làm tròn vì 1 đã là số nguyên

Cảnh báo:

Được hiểu là (ceil 1)/3, chứ không phải ceil(1/3) như một số bạn có thể sẽ nghĩ

Rounding large numbers

{{#expr: 1e-92 round 400 }} 1.0E-92 Rounding to a very large number leads to infinity. Hence, the original value without the infinity is given as the answer.

{{#expr: 1e108 round 200 }} 1.0E+108 Same as above.

Xâu

Biểu thức chỉ hoạt động với các giá trị kiểu số, chúng không thể so sánh các xâu hoặc kí tự. #ifeq có thể được dùng thay vào đó.

{{#expr: "a" = "a" }} → Expression error: Unrecognized punctuation character """.

{{#expr: a = a }} → Expression error: Unrecognized word "a".

{{#ifeq: a | a | 1 | 0 }} → 1

#if

Hàm này kiểm tra một xâu thử xem nó rỗng hay không. Một xâu thử chứa chỉ toàn các kí tự trắng cũng được xem là rỗng.

{{#if: xâu thử | giá trị nếu xâu thử không rỗng | giá trị nếu xâu thử rỗng (hoặc chỉ chứa kí tự trắng)}}

{{#if: tham số thứ nhất | tham số thứ hai | tham số thứ ba }}

Hàm này trước tiên kiểm tra xem tham số thứ nhất rỗng hay không. Nếu tham số thứ nhất không rỗng, hàm sẽ trả về tham số thứ hai. Nếu tham số thứ nhất rỗng hoặc chỉ chứa các kí tự trắng (khoảng trắng, dấu xuống dòng, v.v...), hàm sẽ trả về tham số thứ ba.

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

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

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

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

Xâu thử luôn luôn được hiểu là văn bản thuần (pure text), vì thế các biểu thức toán học không được thực hiện:

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

{{#if: 0 | yes | no }} → yes

Tham số cuối cùng (false) có thể để trống:

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

{{#if: | yes }} →

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

Hàm này có thể được lồng vào nhau. Muốn vậy, đưa một hàm #if ở dạng đầy đủ vào vị trí một tham số của một hàm #if khác. Có thể lên tới 7 cấp độ làm tổ, tuy nhiên điều này có thể phụ thuộc vào wiki hoặc giới hạn bộ nhớ.

{{#if:xâu thử
|giá trị nếu xâu thử không rỗng
|{{#if:test string
  |value if test string is not empty
  |giá trị nếu xâu thử rỗng (hoặc chỉ chứa kí tự trắng)
  }}
}}

Bạn cũng có thể dùng một tham số làm xâu thử trong lần gọi #if. Hãy nhớ đừng quên thêm | (dấu sổ thẳng, dấu sổ dọc) sau tên của biến. (Để nếu tham số cuối cùng không có giá trị, nó sẽ được đánh giá thành một xâu rỗng thay ví xâu "{{{1}}}".)

{{#if:{{{1|}}}|Bạn đã nhập văn bản cho biến 1|Văn bản không được nhập cho biến 1}}

Xem Help:Parser functions in templates để xem thêm các ví dụ khác về parser function này.

#ifeq

Hàm phân tích cú pháp này so sánh hai xâu đầu vào, xác định xem chúng có giống nhau hay không và trả về một trong hai xâu dựa trên kết quả. Nếu cần so sánh nhiều hơn và có xâu đầu ra, hãy cân nhắc sử dụng #switch.

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

Nếu cả hai xâu là các giá trị số hợp lệ, chúng được so sánh như hai số:

{{#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

Ngược lại, chúng được so sánh như hai văn bản; việc so sánh là phân biệt hoa thường (case sensitive):

{{#ifeq: foo | bar | equal | not equal}} → not equal

{{#ifeq: foo | Foo | equal | not equal}} → not equal

{{#ifeq: "01" | "1" | equal | not equal}} → not equal (so sánh với ví dụ tương tự ở trên, không có ngoặc kép)

{{#ifeq: 10^3 | 1000 | equal | not equal}} → not equal (so sánh với ví dụ tương tự ở trên, với #expr trả về một số hợp lệ trước tiên)

Để làm ví dụ thực tế, hãy xem xét bản mẫu Template:Timer hiện có bằng cách sử dụng trình phân tích cú pháp để chọn giữa hai thời điểm chuẩn, ngắn và dài. Nó nhận tham số này làm đầu vào đầu tiên để so sánh với xâu "short"– không có quy ước nào về thứ tự, nhưng sẽ dễ đọc hơn nếu tham số này đứng trước. Mã bản mẫu được định nghĩa là:

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

khi đó:

{{timer|short}} → 20

{{timer|20}} → 40

{{timer}} → 40

Cảnh báo:

Khi các thẻ phân tích và các hàm phân tích được lồng bên trong một hàm phân tích, chúng phải được thay thế bằng đoạn mã duy nhất. Điều này ảnh hưởng đến các phép so sánh:

{{#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

If the strings to be compared are given as equal calls to the same template containing such tags, then the condition is true, but in the case of two templates with identical content containing such tags it is false.

Cảnh báo:

Literal comparisons to page-name magic words may fail depending on site configuration. For example, {{FULLPAGENAME}}, depending on wiki, may capitalize the first letter, and will replace all underscores with spaces.

To work around this, apply the magic word to both parameters:

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

#iferror

Hàm này nghiên cứu xâu được nhập vào và trả về một trong hai kết quả; hàm này xem xâu là true nếu xâu có chứa một object HTML với class="error", tạo ra bởi các parser functions khác như #expr, #time và #rel2abs, các lỗi bản mẫu như lặp (loops) và đệ quy (recursion), cũng như các lỗi "failsoft" parser khác.

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

Một hoặc cả hai giá trị trả về có thể được để trống. Nếu value if correct được để trống và hàm xác định xâu đưa vào là không lỗi, hàm sẽ trả về chính xâu đó. Nếu value if error được để trống, khi gặp lỗi hàm sẽ trả về một xâu rỗng.

{{#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

Some errors may cause a tracking category to be added, using {{#iferror:}} will not suppress the addition of the category.

#ifexpr

Hàm này tính toán giá trị của biểu thức toán học đưa vào và trả về một trong hai xâu phụ thuộc vào giá trị boole (đúng/sai) của kết quả:

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

The expression input is evaluated exactly as for #expr above, with the same operators being available. The output is then evaluated as a boolean expression.

An empty input expression evaluates to false:

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

As mentioned above, zero evaluates to false and any nonzero value evaluates to true, so this function is equivalent to one using #ifeq and #expr only:

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

except for an empty or wrong input expression (an error message is treated as an empty string; it is not equal to zero, so we get value if true).

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

comparing

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

Either or both of the return values may be omitted; no output is given when the appropriate branch is left empty:

{{#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

{{#ifexpr: 2 > 0 or 1 < 0 | yes}} → yes

{{#ifexpr: 2 > 0 and 1 > 0 | yes | no}} → yes

Cảnh báo:

The results of numerical comparisons with #ifexpr do not always match those of #ifeq and #switch. These latter two are more accurate than #ifexpr, and so may not return equivalent results.

Consider these comparisons with the final digit changed:

{{#ifeq: 12345678901234567 | 12345678901234568 | equal | not equal}} → not equal

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

Because PHP used in #ifeq and #switch compares two numbers of type integer, it returns the expected result correctly. Whereas with #ifexpr and the same numbers:

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

With the different digit, the result of equal is actually incorrect.

This behaviour in #ifexpr is caused because MediaWiki converts literal numbers in expressions to type float, which, for large integers like these, involves rounding.

#ifexist

This function takes an input string, interprets it as a page title, and returns one of two values depending on whether or not the page exists on the local wiki.

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

The function evaluates to true if the page exists, whether it contains content, is visibly blank (contains meta-data such as category links or magic words , but no visible content), is blank, or is a redirect . Only pages that are redlinked evaluate to false, including if the page used to exist but has been deleted.

{{#ifexist: Help:Extension:ParserFunctions/vi | exists | doesn't exist }} → exists

{{#ifexist: XXHelp:Extension:ParserFunctions/viXX | exists | doesn't exist }} → doesn't exist

The function evaluates to true for system messages that have been customized, and for special pages that are defined by the software.

{{#ifexist: Special:Watchlist | exists | doesn't exist }} → exists

{{#ifexist: Special:CheckUser | exists | doesn't exist }} → exists (because the Checkuser extension is installed on this wiki)

{{#ifexist: MediaWiki:Copyright | exists | doesn't exist }} → doesn't exist (because MediaWiki:Copyright has not been customized)

If a page checks a target using #ifexist:, then that page will appear in the Special:WhatLinksHere list for the target page. So if the code {{#ifexist:Foo }} were included live on this page (Help:Extension:ParserFunctions/vi), Special:WhatLinksHere/Foo will list Help:Extension:ParserFunctions/vi.

On wikis using a shared media repository, #ifexist: can be used to check if a file has been uploaded to the repository but not to the wiki itself:

{{#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

If a local description page has been created for the file, the result is exists for all of the above.

#ifexist: does not work with interwiki links.

Giới hạn của ifexist

#ifexist: được coi là một "hàm phân tích tốn kém"; chỉ một số lượng giới hạn có thể được nhúng vào bất kì một trang nào (bao gồm các hàm trong các bản mẫu được truyền tải). Khi đạt đến giới hạn, những hàm #ifexist: chạy sau sẽ tự động trả về false false, dù trang mục tiêu có tồn tại hay không, và trang đó sẽ được đưa vào Category:Pages with too many expensive parser function calls. Tên của thể loại theo dõi có thể khác nhau tuỳ thuộc vào ngôn ngữ nội dung của wiki của bạn.

For some use cases it is possible to emulate the ifexist effect with css, by using the selectors a.new (to select links to unexisting pages) or a:not(.new) (to select links to existing pages). Furthermore, since the number of expensive parser functions that can be used on a single page is controlled by $wgExpensiveParserFunctionLimit , one can also increase the limit in LocalSettings.php if needed.

ifexist and wanted pages

A page that does not exist and is tested for using #ifexist will end up on the Wanted Pages. See task T14019 for the reason, and w:Template:Linkless exists for a workaround.

#rel2abs

This function converts a relative file path into an absolute filepath.

{{#rel2abs: path }}

{{#rel2abs: path | base path }}

Within the path input, the following syntax is valid:

. → the current level
.. → go up one level
/foo → go down one level into the subdirectory /foo

If the base path is not specified, the full page name of the page will be used instead:

{{#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

Invalid syntax, such as /. or /./, is ignored. Since no more than two consecutive full stops are permitted, sequences such as these can be used to separate successive statements:

{{#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 }} → Lỗi: độ sâu không hợp lệ trong đường dẫn “Help:Foo/bar/baz/../../../../quok” (do cố gắng truy cập nút phía trên nút gốc)

For a similar group of functions see also Help:Magic words#URL data. Built-in parser functions include: 'localurl:', 'fullurl:', 'anchorencode:' etc.

#switch

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.

Mặc định

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.

Sử dụng với tham số

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:Parser functions in templates .)

{{#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|}}}).

Hành vi so sánh

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: 02 | +1 = one | +2 = two | three}} → two

{{#switch: 100 | 1e1 = ten | 1e2 = hundred | other}} → hundred

{{#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

Cảnh báo:

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, use the {{=}} magic word, or replace equals sign with HTML code =.

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=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 Bản mẫu:Phần mở rộng 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

Code	Description	Current output (Purge this page's cache to update)
Năm
`Y`	Năm 4 chữ số	2024
`y`	Năm 2 chữ số	24
`L`	1 nếu là năm nhuận, 0 nếu không phải.	1
`o`^{[note 1]}	ISO-8601 year of the specified week.^{[note 2]}	2024^{[note 3]}
↑ Requires PHP 5.1.0 and newer and rev:45208. ↑ This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead. ↑ Will output literal o if note 1 not fulfilled.
Tháng
`n`	Tháng theo số, không độn 0.	11
`m`	Tháng theo số, độn 0.	11
`M`	Tên tháng viết tắt, theo ngôn ngữ trang web.	tháng 11
`F`	Tên tháng đầy đủ, theo ngôn ngữ trang web.	tháng 11
`xg`	Output the full month name in the genitive form for site languages that distinguish between genitive and nominative forms. This option is useful for many Slavic languages like Polish, Russian, Belarusian, Czech, Slovak, Slovene, Ukrainian, etc.	For Polish: `{{#time:F Y\|June 2010\|pl}}` → czerwiec 2010 (nominative) `{{#time:d xg Y\|20 June 2010\|pl}}` → 20 czerwca 2010 (genitive)
Ngày trong tháng hoặc năm
`j`	Ngày trong tháng, không độn 0.	21
`d`	Ngày trong tháng, độn 0.	21
`z`	Ngày trong năm (1 tháng 1 = 0). Ghi chú: Để lấy ngày ISO trong năm, hãy cộng 1.	325
Tuần và ngày trong tuần
`W`	Số tuần ISO 8601, độn 0.	47
`N`	Ngày ISO 8601 trong tuần (Thứ 2 = 1, Chủ nhật = 7).	4
`w`	Ngày trong tuần (Chủ nhật = 0, thứ 7 = 6)	4
`D`	Tên thứ viết tắt.	Thứ 5
`l`	Tên thứ đầy đủ.	Thứ năm
Giờ
`a`	"am" trong buổi sáng (00:00:00 → 11:59:59) "pm" trong buổi chiều tối (12:00:00 → 23:59:59).	pm
`A`	Phiên bản viết hoa của `a` ở trên.	PM
`g`	Giờ trong quy ước 12 giờ, không độn 0.	12
`h`	Giờ trong quy ước 12 giờ, độn 0.	12
`G`	Giờ trong quy ước 24 giờ, không độn 0.	12
`H`	Giờ trong quy ước 24 giờ, độn 0.	12
Phút và giây
`i`	Phút trong giờ, độn 0.	25
`s`	Giây trong phút, độn 0.	44
`U`	Thời gian Unix. Giây từ 1 tháng 1, 1970 00:00:00 GMT.	1732191944
Timezone (as of 1.22wmf2)
`e`	Timezone identifier.	UTC
`I`	Whether or not the date is in daylight savings time.	0
`O`	Difference to Greenwich time (GMT)	+0000
`P`	Difference to Greenwich time (GMT), with colon	+00:00
`T`	Timezone abbreviation.	UTC
`Z`	Timezone offset in seconds.	0
Miscellaneous
`t`	Number of days in the current month.	30
`c`	ISO 8601 formatted date, equivalent to `Y-m-d"T"H:i:s+00:00`.	2024-11-21T12:25:44+00:00
`r`	RFC 5322 formatted date, equivalent to `D, j M Y H:i:s +0000`, with weekday name and month name not internationalized.	Thu, 21 Nov 2024 12:25:44 +0000
Non-Gregorian calendars
Islamic
`xmj`	Day of the month.	19
`xmF`	Full month name.	Jumada al-awwal
`xmn`	Month index.	5
`xmY`	Full year.	1446
Iranian (Jalaly)
`xit`	Number of days in the month.	30
`xiz`	Day of the year.	246
`xij`	Day of the month.	1
`xiF`	Full month name.	Azar
`xin`	Month index.	9
`xiY`	Full year.	1403
`xiy`	2-digit year.	03
Hebrew
`xjj`	Day of the month.	20
`xjF`	Full month name.	Cheshvan
`xjt`	Number of days in month.	30
`xjx`	Genitive form of the month name.	Cheshvan
`xjn`	Month number.	2
`xjY`	Full year.	5785
Thai solar
`xkY`	Full year in Thai solar calendar. Ghi chú: For years before 1941 the dates in Jan-Mar range are not calculated properly.	2567
Minguo/Juche year
`xoY`	Full year.	113
Japanese nengo
`xtY`	Full year.	令和6
Flags
`xn`	Format the next numeric code as a raw ASCII number.	In the Hindi language, `{{#time:H, xnH}}` produces ०६, 06.
`xN`	Like `xn`, but as a toggled flag, which endures until the end of the string or until the next appearance of `xN` in the string.
`xr`	Format the next number as a roman numeral. Only works for numbers up to 10,000 (up to 3,000 in pre MediaWiki 1.20).	`{{#time:xrY}}` → MMXXIV
`xh`	Format the next number as a Hebrew numeral.	`{{#time:xhY}}` → ב'כ"ד

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). If no character is recognized in the formatting string, and the date/time object is without error, then the formatting string is returned as output. There are also two ways to escape characters within the formatting string:

A backslash followed by a formatting character is interpreted as a single literal character

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 }} → 2024-11-21

{{#time: [[Y]] m d }} → 2024 11 21

{{#time: [[Y (year)]] }} → 2024 (24UTCpmThu, 21 Nov 2024 12:25:44 +0000)

{{#time: [[Y "(year)"]] }} → 2024 (year)

{{#time: i's" }} → 25'44"

The date/time object can be in any format accepted by PHP's strtotime() function. Absolute (e.g. 20 December 2000), relative (e.g. +20 hours), and combined times (e.g. 30 July +1 year) are accepted.

{{#time: r|now}} → Thu, 21 Nov 2024 12:25:45 +0000

{{#time: r|+2 hours}} → Thu, 21 Nov 2024 14:25:45 +0000

{{#time: r|now + 2 hours}} → Thu, 21 Nov 2024 14:25:45 +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}} → Lỗi: thời gian không hợp lệ

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}} → 2024 novembre 21 12:25:45

{{#time: Y F d H:i:s|now|it|1}} → 2024 novembre 21 12:25:45

{{#time: Y F d H:i:s|+2 hours||0}} → 2024 tháng 11 21 14:25:45

{{#time: Y F d H:i:s|+2 hours||1}} → 2024 tháng 11 21 14:25:45

{{#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 }} → 1732191945

{{#time: r | @1732191944 }} → Thu, 21 Nov 2024 12:25:44 +0000

Cảnh báo:

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 }} → Lỗi: thời gian không hợp lệ (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 }} → Fri, 21 Nov 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 }} → Sun, 21 Nov 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 }} → Lỗi: thời gian không hợp lệ (unsupported year format)

Cảnh báo:

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 tháng 3 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 }} → Lỗi: thời gian không hợp lệ

{{#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 tháng 1 2006

{{#time: d F Y | 1 Jan 06 }} → 01 tháng 1 2006

{{#time: d F Y | 1 Jan 006 }} → 01 tháng 1 2006

{{#time: d F Y | 1 Jan 0006 }} → 01 tháng 1 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 }} → 2024

Cảnh báo:

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 }} → 2024 06 21 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 11 21 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 11 21 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 }} → 2024 11 21 19:59:09 Input is treated as a time rather than a year+month code.

{{#time: Y m d H:i:s | 196009 }} → Lỗi: thời gian không hợp lệ 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 tháng 12 2007

{{#time: d F | January 32 }} → Lỗi: thời gian không hợp lệ

{{#time: d F | February 29 2008 }} → 29 tháng 2

{{#time: d F | February 29 2007 }} → 01 tháng 3

{{#time:Y-F|now -1 months}} → 2024-tháng 10

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 }} → 8:25 AM

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 }} → 12:25 PM

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

{{#time:g:i A | +330 minutes }} → 5:55 PM
{{#time:g:i A | +19800 seconds }} → 5:55 PM

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

#time format like in signatures

Sometimes it is useful to construct a timestamp, which looks like the automatic timestamp generated by signatures in discussions on talk pages. On an English-language wiki, it can be created with:

{{#timel:H:i, j xg Y (e)|+330 minutes}} → 17:55, 21 tháng Mười một 2024 (UTC)

#timel

This function is a syntactic shortcut that operates identically to {{#time: ... }} with the local parameter set to true, so it always uses the preferred time zone of the user or the configured time zone 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}} → 2024-11-21T12:25:45+00:00

{{#time:c|now|it|0}} → 2024-11-21T12:25:45+00:00

{{#time:c|now|it|1}} → 2024-11-21T12:25:45+00:00

{{#timel:c|now|it}} → 2024-11-21T12:25:45+00:00

Warning Example from https://no.wikipedia.org/wiki/Maldiskusjon:Sommertid

Cảnh báo:

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}} → 1732191944

{{#timel: U}} → 1732191944

{{#time: Z}} → 0

{{#timel: Z}} → 0

#timef

This function formats a date using a standard format for the selected language, as defined in $dateFormats (see task T223772).

{{#timef: date/time object }}

{{#timef: date/time object | format type }}

{{#timef: date/time object | format type | language code }}

The format of the date/time object is the same as for #time. If it is empty, the time when the page was rendered is used.

The format type may be one of:

time: Only the time is shown.
date: Only the date is shown.
both: Both the time and date are shown.
pretty: Only the date is shown, using an abbreviated format which does not include the year. Not all languages support this; if it is not supported, the "date" format is used.

If the format type is not specified, both the time and date will be show, as if both were specified.

If the language code is not specified, the page's content language is used.

Using #timef instead of #time allows templates to more easily support multiple languages, since different languages have different ways to format dates.

In English, the order of the day and month is controlled by $wgAmericanDates .

Examples:

{{#timef:now|both|en}} → 12:25, 21 November 2024

{{#timef:now|both|ja}} → 2024年11月21日 (木) 12:25

{{#timef:now|pretty|en}} → 21 November

{{#timef:now|pretty|pl}} → 21 listopada

{{#timef:|time}} → 12:25

#timefl

This function is the same as #timef except that it uses the local timezone of the wiki as configured in $wgLocaltimezone .

{{#timefl: date/time object }}

{{#timefl: date/time object | format type }}

{{#timefl: date/time object | format type | language code }}

#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 | segment to start at }}

If the number of segments to return parameter is not specified, it defaults to "0", which returns all the segments from the segment to start at to the end (included). If the segment to start at 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 | 3 }} → baz/quok

{{#titleparts: Talk:Foo/bar/baz/quok | 3 | 2 }} → bar/baz/quok

{{#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 ", ", or " 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'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'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'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'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'Or and not the expected Category:Côte-d'Or, and that:
{{PAGESINCAT: Côte-d'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'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:

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.
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
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

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

Cảnh báo:

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.

Cảnh báo:

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

Cảnh báo:

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.

String functions

The ParserFunctions extension optionally defines various string functions if $wgPFEnableStringFunctions is set to true:

#len
#pos
#rpos
#sub
#count
#replace
#explode
#urldecode

See the dedicated subpage for documentation, and Manual:Performing string operations with parser functions for examples.

Cảnh báo:

In 2013, it was decided that these functions will never be enabled on any Wikimedia wiki, because they are inefficient when used on a large scale (see phab:T8455 for some history). These functions do NOT work on Wikimedia wikis!

If you are here to write something on a Wikimedia project, you are looking for something else: if your home wiki has string functions, it probably uses Lua. For example, the English Wikipedia uses Module:String, which does some of the same things with wildly different syntax. There are also individual String-handling templates.

Here is a short overview of Module:String functions:

#len (length of string): {{#invoke:String|len|target_string}}
#sub (substring): {{#invoke:String|sub|target_string|start_index|end_index}}
#match: {{#invoke:String|match|source_string|pattern_string|start_index|match_number|plain_flag|nomatch_output}}
#pos (position of target): {{#invoke:String|pos|target_string|index_value}}
#find: {{#invoke:String|find|source_string|target_string|start_index|plain_flag}}
#replace: {{#invoke:String|replace|source_str|pattern_string|replace_string|replacement_count|plain_flag}}
#rep (repeat): {{#invoke:String|rep|source|count}}
#escapePattern: {{#invoke:String|escapePattern|pattern_string}}
#count: {{#invoke:String|count|source_str|pattern_string|plain_flag}}
#join: {{#invoke:String|join|separator|string1|string2|...}}

General points

Substitution

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

{{subst:#ifexist: Help:Extension:ParserFunctions/vi | [[Help:Extension:ParserFunctions/vi]] | Help:Extension:ParserFunctions/vi }}

→ the code [[Help:Extension:ParserFunctions/vi]] will be inserted in the wikitext since the page Help:Extension:ParserFunctions/vi exists.

Cảnh báo:

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: | .

Description	You type	You get
Escaping pipe character as table row/column separator	{{!}}	\|
Escaping pipe character as a plain character	\|	\|

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 }}foo → foobarfoo

foo{{#if:||<nowiki /> bar <nowiki />}}foo → foo 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   (breakable space) or   (non-breakable space), since they are not modified by the software:

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

foo{{#if:||   bar   }}foo → foo bar foo

Beware that not all parameters are created equal. In ParserFunctions, whitespace at the beginning and end is always stripped. In templates , whitespace at the beginning and end is stripped for named parameters and named unnamed parameters but not from unnamed parameters:

foo{{1x|content= bar}}foo → foobarfoo

foo{{1x|1= bar}}foo → foobarfoo

foo{{1x| bar }}foo → foo bar foo

Other parser functions

Case conversion functions

Lowercase: "{{lc: AbC}}" → "abc" [1]
Uppercase: "{{uc: AbC}}" → "ABC" [2]
Lowercase first character: "{{lcfirst: AbC}}" → "abC" [3]
Uppercase first character: "{{ucfirst: abc}}" → "Abc" [4]

Encoding functions

URL encoding:

"{{urlencode: AbC
dEf ghi}}"

renders as

"AbC%0AdEf+ghi"

So inner new lines convert into %0A, and inner spaces convert into +.

Anchor encoding

{{anchorencode: AbC dEf ghi}}

renders as

AbC_dEf_ghi

Padding functions

"{{padleft: bc d |8|a}}" gives "aaaabc d" [5]
"{{padright: bc d |8|a}}" gives "bc daaaa" [6]

Formatting functions

"{{formatnum: 1234567890}}" gives "1.234.567.890" [7]

References

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

[1] Requires PHP 5.1.0 and newer and rev:45208.

[2] This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead.

[3] Will output literal o if note 1 not fulfilled.

[4] Prior to r86805 in 2011 this was not the case.

[5] ParserFunctions.php at phabricator.wikimedia.org

[note 1]

[note 2]

[note 3]

[1]

[2]

v t e Parser functions
All	A {{#anchorencode }} B {{#babel }} {{#basepagename }} {{#basepagenamee }} C {{#canonicalurl }} {{#canonicalurle }} {{#categorytree }} {{#coordinates }} D {{#defaultsort }} {{#displaytitle }} E {{#expr }} F {{#filepath }} {{#formatdate }} {{#formatnum }} {{#fullpagename }} {{#fullpagenamee }} {{#fullurl }} {{#fullurle }} G {{#gender }} {{#grammar }} I {{#if }} {{#ifeq }} {{#iferror }} {{#ifexist }} {{#ifexpr }} {{#int }} {{#invoke}} L {{#language }} {{#lc }} {{#lcfirst }} {{#localurl }} {{#localurle }} {{#lqtpagelimit }} {{#lst }} {{#lstx }} N {{#namespace }} {{#namespacee }} {{#namespacenumber }} {{#ns }} {{#nse }} {{#numberingroup }} {{#numberofactiveusers }} {{#numberofadmins }} {{#numberofarticles }} {{#numberofedits }} {{#numberoffiles }} {{#numberofpages }} {{#numberofusers }} {{#numberofviews }} P {{#padleft }} {{#padright }} {{#pagename }} {{#pagenamee }} {{#pagesincategory }} {{#pagesize }} {{#plural }} {{#property}} {{#protectionlevel }} R {{#rel2abs }} {{#rootpagename }} {{#rootpagenamee }} S {{#special }} {{#speciale }} {{#statement}} {{#subjectpagename }} {{#subjectpagenamee }} {{#subjectspace }} {{#subjectspacee }} {{#subpagename }} {{#subpagenamee }} {{#switch }} T {{#tag }} {{#talkpagename }} {{#talkpagenamee }} {{#talkspace }} {{#talkspacee }} {{#time }} {{#timel }} {{#timef }} {{#timefl }} {{#titleparts }} {{#translation }} {{#translationdialog }} U {{#uc }} {{#ucfirst }} {{#urlencode }} {{#useliquidthreads }}
See also	Trợ giúp:Tiện ích mở rộng:ParserFunctions Help:Parser functions in templates Parser extension tags Parser function hooks
Translate this navigation box