Template:ExtensionHook
Şablonu kopyalayıp yapıştırın
MyHook | |
---|---|
??? sürümünden itibaren mevcut |
|
İşlev tanımlayın: | public static function onMyHook( $x, $y ) { ... }
|
Ek kanca: | $wgHooks['MyHook'][] = 'MyExtensionHooks::onMyHook';
|
Çağrıdan: | Dosya(lar): |
Kancaların takılmasıyla ilgili daha fazla bilgi için Manual:Hooks sayfasına bakın.
Bu kancayı kullanan diğer uzantı örnekleri için Category:MyHook extensions/tr sayfasına bakın.
{{ExtensionHook |name = MyHook |version = |gerrit = |removed = |summary = |args = $x, $y |extension = |source = |sourcefunction = |sourceclass = |newvarname = |newvarlink = |nocatdesc = }}
Kullanım notları
- name
- Kancanın adı. Bu genellikle alt sayfayla aynı addır.
- version
- MediaWiki sürümü bu kanca ilk olarak tanıtıldı.
- rev
- Bu kancanın ilk kez tanıtıldığı SVN revizyonu. Bu parametre verilirse, uygun CodeReview sayfasına (ör. r115794) bağlanacaktır.
- gerrit
- Bu kancanın ilk tanıtıldığı Gerrit değişim numarası. Bu parametre verilirse, uygun Gerrit değişiklik kümesi sayfasına bağlanır (ör. Gerrit değişikliği 5)
- removed
- Kanca kaldırılmışsa, kaldırıldığı MediaWiki sürümü.
- deprecated
- Kanca kullanımdan kaldırılmışsa (ancak kaldırılmamışsa), kullanımdan kaldırıldığı MediaWiki sürümü.
- summary
- Kancanın amacının kısa bir açıklaması.
- Daha ayrıntılı açıklamalar istenir ve ana sayfa içeriğine eklenmelidir.
- Kısa açıklamayı güncellerseniz, lütfen Manual:Hooks üzerindeki iki tabloyu da güncelleyin.
- args
- İşlevin en üstünde kullanıldığı şekliyle argümanlar.
- extension
- Extension name where hook is called; for when the source is not in the MediaWiki core code repository.
- source
- Bu kancayı kodda çağıran konum (dosya adı). source2...source10 ile daha fazla konum eklenebilir.
- sourcefunction
- Bu kancayı çağıran işlevin adı. sourcefunction2 ile bir başkası eklenebilir.
- sourceclass
- Bu kancayı çağıran sınıfın adı.
- newvarname
- removed veya deprecated ayarlandığında {{Removed }} veya {{Deprecated }} tarafından kullanılır.
- newvarlink
- removed veya deprecated ayarlandığında {{Removed }} veya {{Deprecated }} tarafından kullanılır.
- templatemode
- Kanca belgelerinin standart MediaWiki Kategorileri'nde görünmemesi gerekiyorsa nocats olarak ayarlayın.
- Varsayılan olarak, bu şablonu kullanmak belgelendirme sayfasını kategorilere yerleştirir:
- MediaWiki kancaları
- MediaWiki'ye eklenen kancalar...
- Kanca belgelerinin otomatik olarak kategorize edilmesinin istenmeyen olduğu zamanlar vardır. Örnekler, bir uzantıdaki bir kancayı belgelerken veya şablonun kendisini belgelerken verilebilir.
- nocatdesc
- Bir kanca,
yes
ayarlanarak MediaWiki sürümünden tamamen kaldırılırsa, kategori açıklamasını göstermez.
Template data
A card which describes the information of a hook registered by an extension.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Template mode | templatemode | no description | String | optional |
Name | name | The name of the hook. This is usually the same name as the sub-page. | String | required |
SVN revision introduced | rev | SVN revision in which this hook was first introduced. If this parameter is given, it will link to the appropriate CodeReview page. | String | optional |
Gerrit changeset introduced | gerrit | Gerrit change number in which this hook was first introduced. If this parameter is given, it will link to the appropriate Gerrit changeset page. | Number | suggested |
Version introduced | version | The version of MediaWiki this hook was first introduced in. | String | suggested |
Version deprecated | deprecated | If the hook has been deprecated, the version of MediaWiki that it was deprecated in. | String | optional |
Gerrit ID of deprecation | gerritdeprecated | no description | Number | optional |
Version removed | removed | If the hook has been removed, the version of MediaWiki that it was removed in. | String | optional |
Gerrit ID of removal | gerritremoved | no description | Number | optional |
Replacement name | newvarname | If the hook is either deprecated or removed, name the feature that replaces this hook, if there is any replacement. | String | optional |
Replacement link | newvarlink | If the hook is either deprecated or removed, link to the feature that replaces this hook, if there is any replacement. | Page name | optional |
Summary | summary | A short description of the hook's purpose. More detailed descriptions are desirable, and should be added to the main page content. | String | suggested |
Arguments | args | The arguments that are defined by the hook signature. | String | required |
Extension name | extension | Extension name where the hook is called; for when the source is not in the MediaWiki core code repository. | Page name | required |
Skin name | skin | Skin name where the hook is called; alternatively, set for the 'extrension' variable. | Page name | optional |
Source 1 | source | Location (file name) which calls this hook in the code. | String | suggested |
Source 2 | source2 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 3 | source3 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 4 | source4 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 5 | source5 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 6 | source6 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 7 | source7 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 8 | source8 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 9 | source9 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 10 | source10 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source class | sourceclass | The fully qualified class name (FQCN) which calls this hook. | String | suggested |
Source function | sourcefunction | Name of the function which calls this hook | String | suggested |
Source function 2 | sourcefunction2 | Name of the function which calls this hook, if another functions call this hook | String | optional |
No category description | nocatdesc | Allows to hide the category hook description if the hook was removed completely from MediaWiki version. | String | optional |