Modèle:ExtensionHook
Copier/coller le modèle
MyHook | |
---|---|
Disponible depuis la version ??? |
|
Fonction à définir : | public static function onMyHook( $x, $y ) { ... }
|
Accroche correspondante : | $wgHooks['MyHook'][] = 'MyExtensionHooks::onMyHook';
|
Appelé de : | Fichier(s) : |
Pour plus d'information sur la manière d'attacher des accroches (hooks), voir Accroches .
Pour des exemples d'autres extensions qui utilisent cette accroche, voir Category:MyHook extensions/fr .
{{ExtensionHook |name = MyHook |version = |gerrit = |removed = |summary = |args = $x, $y |extension = |source = |sourcefunction = |sourceclass = |newvarname = |newvarlink = |nocatdesc = }}
Notes d'utilisation
- name
- Nom de l'accoche. C'est habituellement le même nom que celui de la sous-page.
- version
- Version de MediaWiki pour laquelle cette accroche a été introduite pour la première fois.
- rev
- Révision 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 r115794).
- 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 5)
- 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.
- extension
- Extension name where hook is called; for when the source is not in the MediaWiki core code repository.
- 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 via sourcefunction2.
- sourceclass
- Nom de la classe qui appelle cette accroche.
- newvarname
- Utilisé par {{Removed }} ou {{Deprecated }} lorsque removed ou deprecated est positionné.
- newvarlink
- Utilisé par {{Removed }} ou {{Deprecated }} lorsque removed ou deprecated est positionné.
- templatemode
- Mettre nocats si vous ne voulez pas que la documentation de l'accroche apparaisse dans les catégories standard de MediaWiki.
- Par défaut, l'utilisation de ce modèle place la documentation dans les catégories :
- Accroches MediaWiki
- Accroches ajoutées à MediaWiki...
- Dans certains cas, il n'est pas souhaitable que la documentation de l'accroche soit automatiquement catégorisée. Des exemples seront inclus lors de la documentation d'une accroche, ou à la documentation du modèle lui-même.
- nocatdesc
- Si une accroche est complètement supprimée de la version de MediaWiki en positionnant
yes
, la description de la catégorie ne sera pas affichée.
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 |