Manual:Magic words/id



Kata ajaib adalah teknik untuk memetakan beragam untai teks wiki ke satu kode yang terkait dengan suatu fungsi. Variabel dan fungsi parser menggunakan teknik ini. Semua teks yang dipetakan terhadap kode tersebut akan digantikan dengan nilai balikan fungsi. Pemetaan antara untai teks dan ID disimpan dalam variabel  di dalam satu berkas yang dapat dimuat menggunakan.

Kata ajaib bawaan diimplementasikan di.

Bagaimana kata pencarian bekerja
Setiap kali MediaWiki menemukan teks di antara tanda kurung kurawal ganda, MediaWiki harus menyimpulkan apakah XXX adalah sebuah variabel, fungsi parser, atau templat. Untuk melakukannya, MediaWiki melihat serangkaian pertanyaan:


 * 1) Apakah hal itu berkaitan dengan kata kunci ID?" Sebagai langkah awal dalam memecahkan kode yang ditandai . MediaWiki berupaya untuk menerjemahkan "XXX" ke kata kunci ID. Tabel terjemahan didefiniskan dengan $magicWords.
 * 2) *Apabila tidak ada kata kunci ID yang terdaftar di dalam "XXX". "XXX" dianggap sebagai template.
 * 3) Apakah itu sebuah variabel? Jika ID kata ajaib ditemukan, MediaWiki lalu memeriksa apakah itu punya parameter.
 * 4) *Jika tidak ditemukan parameter, MediaWiki memeriksa apakah ID kata ajaib telah dideklarasikan sebagai ID variabel. Untuk memeriksa ini, MediaWiki melihat daftar kata ajaib dengan memanggil . This method gets its list of variable IDs from a hard coded list of variable IDs (see ) and from a list of custom variable IDs provided by all functions attached to the hook.
 * 5) ** If the magic word ID has been classified as a variable, hooks MediaWiki calls the functions associated with the event name until one is found that recognizes the magic word and can return its value.
 * 6) Is it a parser function? If there are any parameters or if the magic word ID is missing from the list of variable magic word IDs, then MediaWiki assumes that the magic word is a parser function or template.  If the magic word ID is found in the list of parser functions declared via a call to , it is treated as a parser function and rendered using the function named  .  Otherwise, it is presumed to be a template.
 * 1) Is it a parser function? If there are any parameters or if the magic word ID is missing from the list of variable magic word IDs, then MediaWiki assumes that the magic word is a parser function or template.  If the magic word ID is found in the list of parser functions declared via a call to , it is treated as a parser function and rendered using the function named  .  Otherwise, it is presumed to be a template.
 * 1) Is it a parser function? If there are any parameters or if the magic word ID is missing from the list of variable magic word IDs, then MediaWiki assumes that the magic word is a parser function or template.  If the magic word ID is found in the list of parser functions declared via a call to , it is treated as a parser function and rendered using the function named  .  Otherwise, it is presumed to be a template.

Defining magic words
For magic words to do their magic we must define two things:
 * a mapping between wiki text and a magic word ID
 * a mapping between a magic word ID and some php function that interprets the magic word.

Mapping wiki text to magic word IDs
The variable $magicWords is used to associate each magic word ID with a language-dependent array that describes all the text strings that mapped to the magic word ID. Important: This only sets up the back end i18n mapping, you still have to write other code to make MediaWiki use the magic word for anything

The first element of this array is an integer flag indicating whether or not the magic word is case sensitive. The remaining elements are a list of text that should be associated with the magic word ID. If the case sensitive flag is 0, any case variant of the names in the array will match. If the case sensitive flag is 1, only exact case matches will be associated with the magic word ID. Thus the format is

This association is created by $magicWords in a file registered using.

In the example below, a Spanish MediaWiki installation will associate the magic word ID 'MAG_CUSTOM' with "personalizado", "custom", "PERSONALIZADO", "CUSTOM" and all other case variants. In an English MediaWiki only "custom" in various case combinations will be mapped to 'MAG_CUSTOM':

File :

In part of the extension.json file:

Note that "ExampleMagic" is a different to the key you would use for a plain internationalization file (normally just the title of the extension, i.e. "Example"). "Magic" has been appended deliberately so one does not overwrite the other.

In inline PHP
You can associate magic words inline in PHP rather than through a i18n file. This is useful when defining hooks in

Associating a magic word ID with a PHP function
The mechanism for associating magic word IDs with rendering functions depends on whether the magic word will be used as a parser function or a variable. For more information, please see:



Registering magic words
There is no explicit requirement to register magic word IDs. Registering the parser function or variables that use them is sufficient.

Localisation

 *  See Help:Magic words#Localisation for help. 

You can read more on definition and usage of magic words for localisation at Localisation#PLURAL and GENDER support in JavaScript, Localisation#Localizing namespaces and special page aliases, Localisation#Switches in messages…; Localisation#Be aware of PLURAL use on all numbers, Localisation#Users have grammatical genders, Avoid  in messages.

Behavior switches (double underscore magic words)
Behavior switches are a special type of magic word. They can be recognized by their use of double underscores (rather than double braces). For example,.

These magic words typically do not output any content, but instead change the behavior of a page and/or set a page property. These magic words are listed in  and also at Help:Magic words#Behavior switches. The effect of each behavior switch is defined in. If no specific effect is defined, the magic word will simply set a page property in the page_props table.

Lihat pula

 * Help:Magic words - List of Variables like and