Jump to content

Template:ExtensionHook/nl

From mediawiki.org
This page is a translated version of the page Template:ExtensionHook and the translation is 100% complete.
Template documentation

Kopieer en plak sjabloon

MyHook
Beschikbaar vanaf versie ???

Definiëren functie:
public static function onMyHook( $x, $y ) { ... }
Toevoegen hook:
$wgHooks['MyHook'][] = 'MyExtensionHooks::onMyHook';
Aangeroepen vanuit:Bestand(en):

Voor meer informatie over het koppelen van hooks, zie Manual:Hooks .
Voor voorbeelden van extensies die gebruik maken van deze hook, zie Category:MyHook extensions/nl.

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

Gebruiksopmerkingen

name
De naam van de hook. Dit is meestal hetzelfde als de naam van de subpagina.
version
De versie van MediaWiki waarin deze hook voor het eerst is toegevoegd.
rev
SVN revisie waarin deze hook voor het eerst is toegevoegd. Indien deze parameter wordt gebruikt, dan zal het linken naar de bijbehorende CodeReview pagina (bijv. r115794).
gerrit
'Gerrit change number' waarin deze hook voor het eerst is toegevoegd. Indien deze parameter wordt gebruikt, dan zal het linken naar de bijbehorende Gerrit changeset pagina (bijv. Gerrit change 5)
removed
Indien de hook is verwijderd, de versie van MediaWiki waarin die is verwijderd.
deprecated
Als de hook wordt ontraden (maar nog niet verwijderd), de versie van MediaWiki waarin die hook voor het eerst is ontraden.
summary
Een korte beschrijving van het doel van de hook.
Een uitgebreidere beschrijving is gewenst, maar die kan dan op de hoofdpagina staan.
Als u de korte beschrijving aanpast, pas dan ook de twee tabellen op Manual:Hooks aan.
args
De argumenten, zoals gebruikt bovenaan de functie.
extension
Extension name where hook is called; for when the source is not in the MediaWiki core code repository.
source
Locatie (bestandsnaam) die de hook aanroept in de code. Meerdere locaties kunnen met source2...source10 worden toegevoegd.
sourcefunction
Naam van de functie die de hook aanroept. Eventuele andere functies kunnen met sourcefunction2 worden toegevoegd.
sourceclass
Naam van de class die de hook aanroept.
newvarname
Gebruikt door {{Removed/nl }} of {{Deprecated/nl }} wanneer removed of deprecated is gezet.
newvarlink
Gebruikt door {{Removed/nl }} of {{Deprecated/nl }} wanneer removed of deprecated is gezet.
templatemode
Gezet op nocats als de documentatie van de hook niet in de standaard MediaWiki Categorieën moet komen.
Bij het gebruik van dit sjabloon komt de documentatie-pagina standaard te staan in de categorieën:
  • MediaWiki hooks
  • Hooks toegevoegd in MediaWiki...
Het kan ongewenst zijn dan de hook documentatie automatisch in een categorie komt te staan. In het voorbeeld kan worden aangegeven hoe een hook in een extensie moet worden gebruikt of kan het sjabloon zelf worden beschreven.
nocatdesc
Als de hook verwijderd is uit de MediaWiki versie door het instellen yes, dan wordt het niet getoond bij de categorie beschrijving.

Template data

A card which describes the information of a hook registered by an extension.

Template parameters[Edit template data]

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Template modetemplatemode

no description

Stringoptional
Namename

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

Stringrequired
SVN revision introducedrev

SVN revision in which this hook was first introduced. If this parameter is given, it will link to the appropriate CodeReview page.

Stringoptional
Gerrit changeset introducedgerrit

Gerrit change number in which this hook was first introduced. If this parameter is given, it will link to the appropriate Gerrit changeset page.

Numbersuggested
Version introducedversion

The version of MediaWiki this hook was first introduced in.

Stringsuggested
Version deprecateddeprecated

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

Stringoptional
Gerrit ID of deprecationgerritdeprecated

no description

Numberoptional
Version removedremoved

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

Stringoptional
Gerrit ID of removalgerritremoved

no description

Numberoptional
Replacement namenewvarname

If the hook is either deprecated or removed, name the feature that replaces this hook, if there is any replacement.

Stringoptional
Replacement linknewvarlink

If the hook is either deprecated or removed, link to the feature that replaces this hook, if there is any replacement.

Page nameoptional
Summarysummary

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

Stringsuggested
Argumentsargs

The arguments that are defined by the hook signature.

Stringrequired
Extension nameextension

Extension name where the hook is called; for when the source is not in the MediaWiki core code repository.

Page namerequired
Skin nameskin

Skin name where the hook is called; alternatively, set for the 'extrension' variable.

Page nameoptional
Source 1source

Location (file name) which calls this hook in the code.

Stringsuggested
Source 2source2

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 3source3

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 4source4

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 5source5

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 6source6

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 7source7

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 8source8

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 9source9

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 10source10

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source classsourceclass

The fully qualified class name (FQCN) which calls this hook.

Stringsuggested
Source functionsourcefunction

Name of the function which calls this hook

Stringsuggested
Source function 2sourcefunction2

Name of the function which calls this hook, if another functions call this hook

Stringoptional
No category descriptionnocatdesc

Allows to hide the category hook description if the hook was removed completely from MediaWiki version.

Stringoptional

Zie ook