Modèle: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 96% complete.

Other languages:
Deutsch • ‎English • ‎Nederlands • ‎dansk • ‎español • ‎français • ‎polski • ‎português do Brasil • ‎română • ‎čeština • ‎македонски • ‎русский • ‎नेपाली • ‎中文 • ‎日本語
Documentation du modèle

Copier/coller du modèle

MyHook
Disponible depuis version ???

Fonction à définir :
public static function onMyHook( $x, $y ) { ... }
Attacher un rappel (hook) :

In extension.json:

{
	"Hooks": {
		"MyHook": "MyExtensionHooks::onMyHook"
	}
}

For MediaWiki ≤1.25:

$wgHooks['MyHook'][] = 'MyExtensionHooks::onMyHook';
Appelé de :Fichier(s) :

Pour plus d'information sur l'ajout des accroches (hooks), voir Manuel:Accroches.
Pour des exemples d'extensions utilisant cette accroche, voir Category:MyHook extensions/fr .

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

Notes d'utilisation

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
New variable namenewvarname

no description

Unknownoptional
New variable linknewvarlink

no description

Unknownoptional
Version deprecateddeprecated

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

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. [[Special:Code/MediaWiki/1]]).

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
Le nom de l'accoche. C'est habituellement le même nom que le nom de la sous-page.
version
La version de MediaWiki pour laquelle cette accroche a été introduite pour la première fois.
rev
La révision de SVN pour laquelle cette accroche a été introduite pour la première fois. Si ce paramètre est fourni, il pointera vers la page CodeReview concernée (par exemple Special:Code/MediaWiki/1).
gerrit
Numéro de modification Gerrit pour lequel cette accroche a été introduite pour la première fois. Si ce paramètre est fourni, il doit pointer vers la page du groupe de modifications approprié de Gerrit (par exemple Gerrit modification 1)
removed
Si l'accroche a été supprimée, la version de MediaWiki dans laquelle la suppression a eu lieu.
deprecated
Si l'accroche est obsolète, (mais n'a pas été supprimée), la version de MediaWiki dans laquelle l'obsolescence a été déclarée.
summary
Une brève description de ce que fait l'accroche.
Une description plus détaillée est souhaitable, et doit être ajoutée au contenu de la page principale.
Si vous mettez à jour la description courte, pensez également à mettre à jour les deux tables de Accroches .
args
Les arguments, tels qu'ils sont utilisés au début de la fonction.
source
Emplacement (nom de fichier) qui appelle cette accroche dans le code. D'autres emplacements peuvent être ajoutés via source2...source10.
sourcefunction
Nom de la fonction qui appelle cette accroche. On peut en ajouter une autre à travers la fonction source.
sourceclass
Nom de la classe qui appelle cette accroche.
templatemode
mettre à nocats si la documentation de l'accroche ne doit pas apparaître dans les catégories standard de MediaWiki.
Par défaut, l'utilisation de ce modèle place la page de documentation dans les catégories :
  • Accroches de MediaWiki
  • Accroches ajoutées dans MediaWiki...
Dans certains cas, il n'est pas souhaitable que la documentation de l'accroche soit automatiquement catégorisée. Des exemples seront inclus dans la documentation d'une accroche, ou pour la documentation du modèle lui-même.

Chercher la version d'une accroche et l'ID de Gerrit

Pour initialiser les attributs version et gerrit de ce modèle, vous pourriez avoir besoin de chercher l'historique du fichier docs/hooks.txt.

  1. (A partir de la racine d'un clone Git du code source de MediaWiki)
  2. Chercher la plus ancienne validation de hooks.txt qui mentionne cette accroche :
    • git grep <nom de l'accroche, ici> $(git rev-list --all -- docs/hooks.txt) -- docs/hooks.txt | tail -n 1
  3. Trouver son ID Gerrit :
    • git log <la validation ci-dessus>
    1. Copier l'ID de la modification à partir de l'entrée du journal vers la boîte de recherche de Gerrit
    2. Sélectionnez la modification adéquate, et obtenez son ID
  4. Trouver dans quelle version l'accroche est apparue pour la première fois :
    • git tag --contains <la validation ci-dessus>