Template:MediaWikiHook

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page Template:MediaWikiHook and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎polski • ‎português do Brasil • ‎română • ‎čeština • ‎македонски • ‎русский • ‎नेपाली • ‎中文 • ‎日本語
Şablon belgelemesi

Şablonu kopyalayıp yapıştırın

MyHook
sürüm ??? sürümünden mevcuttur

İşlevi tanımlayın:
public static function onMyHook( $x, $y ) { ... }
Ek kancası

extension.json sürümünde:

{
	"Hooks": {
		"MyHook": "MyExtensionHooks::onMyHook"
	}
}
Çağrıdan:Dosya(lar):
Arayüz:MyHookHook.php

Kancaların takılmasıyla ilgili daha fazla bilgi için Manual:Hooks sayfasına bakın.
Bu kancayı kullanan uzantı örnekleri için Category:MyHook extensions/tr sayfasına bakın.

{{MediaWikiHook
|name = MyHook
|version =
|gerrit =
|removed =
|summary =
|args = $x, $y
|source =
|sourcefunction =
|sourceclass =
|newvarname =
|newvarlink =
}}

Kullanım notları

A card which describes the information of a MediaWiki-registered hook.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Template modetemplatemode

Set to nocats if hook documentation should not appear in standard MediaWiki Categories. By default, using this template places the documentation page into categories: MediaWiki hooks Hooks added in MediaWiki... There are times when it is undesirable to automatically categorize the hook documentation. Examples would include when documenting a hook in an extension, or when documenting the template itself.

Unknownoptional
Namename

The name of the hook. This is usually the same name as the sub-page.

Unknownoptional
Versionversion

The version of MediaWiki this hook was first introduced in.

Unknownsuggested
Version removedremoved

If the hook has been removed, the version of MediaWiki that it was removed in.

Stringoptional
Message for removed hookremoved-msg

If it is not suitable to use either the "newvarname" or the "newvarlink" template parameter, use this parameter. This parameter can be used to explain why it was removed, or for example, explain why there is no suitable replacement.

Stringoptional
Version deprecateddeprecated

If the hook has been deprecated (but not removed), the version of MediaWiki that it was deprecated in.

Unknownoptional
Message for deprecated hookdeprecated-msg

If it is not suitable to use either the "newvarname" or the "newvarlink" template parameter, use this parameter. This parameter can be used to explain why it was removed, or for example, explain why there is no suitable replacement.

Stringoptional
New variable namenewvarname

For removed or deprecated hooks, the name of the hook that should be used instead

Unknownoptional
New variable linknewvarlink

For removed or deprecated hooks, the link to the hook that should be used instead

Unknownoptional
SVN revision introducedrev

SVN revision in which this hook was first introduced. If this parameter is given, it'll link to the appropriate CodeReview page (e.g. [[phabricator:rSVN1]]).

Unknownoptional
Gerrit changesetgerrit

Gerrit change number in which this hook was first introduced. If this parameter is given, it'll link to the appropriate Gerrit changeset page (e.g. Gerrit change 1)

Unknownsuggested
Summarysummary

A short description of the hook's purpose. More detailed descriptions are desirable, and should be added to the main page content.

Unknownrequired
Argumentsargs

The arguments, as used at the top of the function.

Unknownrequired
Extensionextension

no description

Unknownoptional
File sourcesource

Location (file name/path not including <code>includes/</code>) which calls this hook in the code. Further locations can be added via source2...source10.

Unknownsuggested
File source 2source2

no description

Unknownoptional
File source 3source3

no description

Unknownoptional
File source 4source4

no description

Unknownoptional
File source 5source5

no description

Unknownoptional
File source 6source6

no description

Unknownoptional
File source 7source7

no description

Unknownoptional
File source 8source8

no description

Unknownoptional
File source 9source9

no description

Unknownoptional
File source 10source10

no description

Unknownoptional
Function sourcesourcefunction

Name of the function which calls this hook. Another can be added via sourcefunction2.

Unknownsuggested
Function source 2sourcefunction2

no description

Unknownoptional
Class sourcesourceclass

Name of the class which calls this hook.

Unknownsuggested
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 bağlanır (ör. phabricator:rSVN1).
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 1)
removed
Kanca kaldırılmışsa, kaldırıldığı MediaWiki sürümü.
deprecated
Kanca kullanımdan kaldırıldıysa (ancak kaldırılmadıysa), 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.
source
Bu kancayı kodda çağıran konum (dosya adı). source2...source10 yoluyla daha fazla konum eklenebilir.
sourcefunction
Bu kancayı çağıran işlevin adı. Kaynak işlevi aracılığıyla bir başkası eklenebilir.
sourceclass
Bu kancayı çağıran sınıfın adı.
templatemode
Kanca dokümantasyonunun standart MediaWiki Kategorisinde 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.

Bir kancanın versiyonunu ve Gerrit kimliğini bulma

Bu şablonun version ve gerrit özniteliklerini doldurmak için docs/hooks.txt dosyasının geçmişini aramanız gerekebilir.

  1. (MediaWiki kaynak kodunun Git klonunun en üst düzeyinden)
  2. Kancadan bahseden en eski hooks.txt taahhüdünü bulun:
    • git grep <kanca-adı-buraya> $(git rev-list --all -- docs/hooks.txt) -- docs/hooks.txt | tail -n 1
  3. Gerrit kimliğini bulun:
    • git log <yukarıdan-taahhüt>
    1. Değişiklik kimliğini günlük girişinden Gerrit arama kutusuna kopyalayın
    2. İlgili değişikliği seçin ve kimliğini alın
  4. Kancanın ilk olarak hangi yayınlanma dahil edildiğini öğrenin:
    • git tag --contains <yukarıdan-taahhüt>