Template:MediaWikiHook
Copy and paste template
| MyHook | |
|---|---|
| <translate> Available from <tvar name=1><translate> version <tvar </tvar></translate> | |
| <translate> Define function:</translate> | public static function onMyHook( $x, $y ) { ... }
|
| <translate> Attach hook:</translate> | <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
"Hooks": {
"MyHook": "MediaWiki\\Extension\\MyExtension\\Hooks::onMyHook"
}
}
|
| <translate> Called from:</translate> | <translate> File(s):</translate> |
| <translate> Interface:</translate> | MyHookHook.php |
<translate> For more information about attaching hooks, see <tvar name=1>Manual:Hooks</tvar>.</translate>
<translate> For examples of extensions using this hook, see <tvar name=cat>Category:MyHook extensions</tvar>.</translate>
{{MediaWikiHook
|name = MyHook
|version =
|gerrit =
|gerritremoved =
|removed =
|summary =
|args = $x, $y
|source =
|sourcefunction =
|sourceclass =
|newvarname =
|newvarlink =
|nocatdesc =
}}
Usage notes
This is the TemplateData documentation for this template used by VisualEditor and other tools.
MediaWikiHook
<templatedata>
{
"description": {
"en": "A card which describes the information of a MediaWiki-registered hook.",
"cs": "Karta, která popisuje informace o háčku registrovaném na MediaWiki.",
"fr": "Fiche décrivant l'information d'une accroche enregistrée de MediaWiki."
},
"format": "block",
"params": {
"templatemode": {
"label": {
"en": "Template mode",
"cs": "Režim šablony",
"fr": "mode du modèle"
},
"description": {
"en": "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.",
"cs": "Nastavte na nocats, pokud by se dokumentace hářku neměla objevovat ve standardních kategoriích MediaWiki. Standardně při použití této šablony umístíte stránku dokumentace do kategorií: MediaWiki háčky Háčky přidané do MediaWiki... Jsou chvíle, kdy je nežádoucí automaticky kategorizovat dokumentaci háčků. Příklady zahrnují dokumentování háčku v rozšíření nebo dokumentování samotné šablony.",
"fr": "mettre nocats si la documentation de l'accroche ne doit pas figurer 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: MediaWiki hooks, Hooks added in MediaWiki... Quelques fois il est souhaitable de ne pas catégoriser automatiquement la documentation de l'accroche; c'est le cas où l'accroche est documentée dans une extension, ou que la documentation se trouve dans le modèle lui même."
},
"type": "string"
},
"name": {
"label": {
"en": "Name",
"cs": "Název",
"fr": "nom"
},
"description": {
"en": "The name of the hook. This is usually the same name as the sub-page.",
"cs": "Název háčku. Obvykle se jedná o stejný název jako podstránka.",
"fr": "nom de l'accroche. Habituellement c'est le même que celui de la sous-page."
},
"type": "string"
},
"version": {
"label": {
"en": "Version",
"cs": "Verze",
"fr": "version"
},
"description": {
"en": "The version of MediaWiki this hook was first introduced in.",
"cs": "Verze MediaWiki, ve které byl tento háček poprvé představen.",
"fr": "version de MediaWiki dans laquelle cette accroche a été initialement introduite."
},
"suggested": true,
"type": "string"
},
"removed": {
"label": {
"en": "Version removed",
"cs": "Verze odstraněna",
"fr": "supprimé"
},
"description": {
"en": "If the hook has been removed, the version of MediaWiki that it was removed in.",
"cs": "Pokud byl háček odstraněn, verze MediaWiki, ve které byl odstraněn.",
"fr": "version de MediaWiki dans laquelle l'accroche a été supprimée, si c'est le cas."
},
"type": "string"
},
"newvarname": {
"label": {
"en": "New variable name",
"cs": "Nový název proměnné",
"fr": "nouveau nom de variable"
},
"description": {
"en": "For removed or deprecated hooks, the name of the hook that should be used instead",
"cs": "U odstraněných nebo zastaralých háčků název háčku, který by měl být místo toho použit",
"fr": "nom de l'accroche à utiliser pour remplacer les accroches supprimées ou devenues obsolètes"
},
"type": "string"
},
"newvarlink": {
"label": {
"en": "New variable link",
"cs": "Nový odkaz na proměnnou",
"fr": "nouveau lien de variable "
},
"description": {
"en": "For removed or deprecated hooks, the link to the hook that should be used instead",
"cs": "U odstraněných nebo zastaralých háčků odkaz na háček, který by měl být použit místo něj",
"fr": "lien de l'accroche à utiliser pour remplacer les liens des accroches supprimées ou devenues obsolètes"
},
"type": "wiki-page-name"
},
"deprecated": {
"label": {
"en": "Version deprecated",
"cs": "Zastaralá verze",
"fr": "obsolète"
},
"description": {
"en": "If the hook has been deprecated (but not removed), the version of MediaWiki that it was deprecated in.",
"cs": "Pokud byl háček zastaralý (ale nebyl odstraněn), verze MediaWiki, ve které byl zastaralý.",
"fr": "version de Mediawiki dans laquelle l'accroche a été déclarée obsolète et n'a pas été supprimée (si c'est le cas)."
},
"type": "string"
},
"rev": {
"label": {
"en": "SVN revision introduced",
"cs": "Zavedena revize SVN",
"fr": "revue de code"
},
"description": {
"en": "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).",
"cs": "Revize SVN, ve které byl tento háček poprvé představen. Pokud je zadán tento parametr, bude odkazovat na příslušnou stránku CodeReview (např. phabricator:rSVN1).",
"fr": "référence SVN de la révision avec laquelle cette accroche a été introduite pour la première fois. Si ce paramètre est fourni, il pointe vers la page de la revue de code correspondante. "
},
"example": {
"fr": "phabricator:rSVN1",
"en": "phabricator:rSVN1"
},
"type": "url"
},
"gerrit": {
"description": {
"en": "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)",
"cs": "Číslo změny Gerrit, ve kterém byl tento háček poprvé představen. Pokud je tento parametr zadán, bude odkazovat na příslušnou stránku Gerrit changeset (např. Gerrit change 1)",
"fr": "référence de la modification Gerrit pour laquelle cette accroche a été introduite pour la première fois. Si ce paramètre est fourni, il pointe vers la page des modifications Gerrit correspondante."
},
"label": {
"en": "Gerrit changeset",
"cs": "Sada změn Gerrit",
"fr": "référence Gerrit"
},
"example": {
"fr": "Gerrit change 1"
},
"suggested": true,
"type": "number"
},
"summary": {
"label": {
"en": "Summary",
"cs": "Souhrn",
"fr": "résumé"
},
"description": {
"en": "A short description of the hook's purpose. More detailed descriptions are desirable, and should be added to the main page content. If you update the short description, please also update the two tables on Special:MyLanguage/Manual:Hooks.",
"cs": "Krátký popis účelu háčku. Jsou žádoucí podrobnější popisy a měly by být přidány k obsahu hlavní stránky. Pokud aktualizujete krátký popis, aktualizujte také dvě tabulky na Special:MyLanguage/Manual:Hooks .",
"fr": "brève description de ce que fait l'accroche. Si une description plus complète est souhaitée, elle doit être ajoutée au contenu de la page d'accueil.Si vous mettez à jour cette courte descrption, reportez également les modifications dans les deux tables de Special:MyLanguage/Manual:Hooks."
},
"required": true,
"type": "string"
},
"args": {
"label": {
"en": "Arguments",
"cs": "Argumenty",
"fr": "arguments"
},
"description": {
"en": "The arguments, as used at the top of the function.",
"cs": "Argumenty, jak se používají v horní části funkce.",
"fr": "arguments tels qu'ils sont utilisés à l'entrée de la fonction"
},
"required": true,
"type": "string"
},
"extension": {
"label": "extension",
"type": "string"
},
"source": {
"label": {
"en": "File source 1",
"cs": "Zdroj souboru 1",
"fr": "fichier appelant 1"
},
"description": {
"en": "Location (file name/path not including includes/) which calls this hook in the code. Further locations can be added via source2...source10.",
"cs": "Umístění (název souboru/cesta bez includes/), které volá tento háček v kódu. Další umístění lze přidat přes source2...source10.",
"fr": "emplacement de code (nom de fichier / chemin autre que includes/) qui appelle cette accroche. D'autres appelants peuvent êtres pécifiés avec source2...source10."
},
"suggested": true,
"type": "wiki-file-name"
},
"source2": {
"label": {
"en": "File source 2",
"cs": "Zdroj souboru 2",
"fr": "fichier appelant 2"
},
"description": {
"fr": "voir source",
"cs": "viz zdroj",
"en": "see source"
},
"type": "wiki-file-name"
},
"source3": {
"label": {
"en": "File source 3",
"cs": "Zdroj souboru 3",
"fr": "fichier appelant 3"
},
"description": {
"fr": "voir source",
"cs": "viz zdroj",
"en": "see source"
},
"type": "wiki-file-name"
},
"source4": {
"label": {
"en": "File source 4",
"cs": "Zdroj souboru 4",
"fr": "fichier appelant 4"
},
"description": {
"fr": "voir source",
"cs": "viz zdroj",
"en": "see source"
},
"type": "wiki-file-name"
},
"source5": {
"label": {
"en": "File source 5",
"cs": "Zdroj souboru 5",
"fr": "fichier appelant 5"
},
"description": {
"fr": "voir source",
"cs": "viz zdroj",
"en": "see source"
},
"type": "wiki-file-name"
},
"source6": {
"label": {
"en": "File source 6",
"cs": "Zdroj souboru 6",
"fr": "fichier appelant 6"
},
"description": {
"fr": "voir source",
"cs": "viz zdroj",
"en": "see source"
},
"type": "wiki-file-name"
},
"source7": {
"label": {
"en": "File source 7",
"cs": "Zdroj souboru 7",
"fr": "fichier appelant 7"
},
"description": {
"fr": "voir source",
"cs": "viz zdroj",
"en": "see source"
},
"type": "wiki-file-name"
},
"source8": {
"label": {
"en": "File source 8",
"cs": "Zdroj souboru 8",
"fr": "fichier appelant 8"
},
"description": {
"fr": "voir source",
"cs": "viz zdroj",
"en": "see source"
},
"type": "wiki-file-name"
},
"source9": {
"label": {
"en": "File source 9",
"cs": "Zdroj souboru 9",
"fr": "fichier appelant 9"
},
"description": {
"fr": "voir source",
"cs": "viz zdroj",
"en": "see source"
},
"type": "wiki-file-name"
},
"source10": {
"label": {
"en": "File source 10",
"cs": "Zdroj souboru 10",
"fr": "fichier appelant 10"
},
"description": {
"fr": "voir source",
"cs": "viz zdroj",
"en": "see source"
},
"type": "wiki-file-name"
},
"sourcefunction": {
"label": {
"en": "Function source 1",
"cs": "Zdroj funkce 1",
"fr": "fonction appelante 1"
},
"description": {
"en": "Name of the function which calls this hook. Another can be added via sourcefunction2.",
"cs": "Název funkce, která volá tento háček. Další lze přidat pomocí sourcefunction2.",
"fr": "nom de la fonction qui appelle cette accroche. Une seconde fonction peut être déclarée via sourcefunction2."
},
"suggested": true,
"type": "string"
},
"sourcefunction2": {
"label": {
"en": "Function source 2",
"cs": "Zdroj funkce 2",
"fr": "fonction appelante 2"
},
"description": {
"fr": "voir sourcefunction",
"cs": "viz zdrojová funkce",
"en": "see sourcefunction"
},
"type": "string"
},
"sourceclass": {
"label": {
"en": "Class source",
"cs": "Zdroj třídy",
"fr": "classe appelante"
},
"description": {
"en": "Name of the class which calls this hook.",
"cs": "Název třídy, která volá tento háček.",
"fr": "nom de la classe qui appelle cette accroche."
},
"suggested": true,
"type": "string"
},
"removed-msg": {
"label": {
"en": "Message for removed hook",
"cs": "Zpráva pro odstraněný háček",
"fr": "message de supression"
},
"description": {
"en": "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.",
"cs": "Pokud není vhodné použít parametr šablony \"newvarname\" nebo \"newvarlink\", použijte tento parametr. Tento parametr lze použít k vysvětlení, proč byl odstraněn, nebo například k vysvětlení, proč neexistuje vhodná náhrada.",
"fr": "utiliser ce paramètre si les paramètres \"newvarname\" ou \"newvarlink\" du modèle ne conviennent pas. Ce paramètre donne alors la raison de la supression, ou explique par exemple, pourquoi la substitution n'est pas possible."
},
"type": "string"
},
"deprecated-msg": {
"label": {
"en": "Message for deprecated hook",
"cs": "Zpráva pro zastaralý háček",
"fr": "message d'obsolescence"
},
"description": {
"en": "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.",
"cs": "Pokud není vhodné použít parametr šablony \"newvarname\" nebo \"newvarlink\", použijte tento parametr. Tento parametr lze použít k vysvětlení, proč byl odstraněn, nebo například k vysvětlení, proč neexistuje vhodná náhrada.",
"fr": "utiliser ce paramètre si \"newvarname\" ou \"newvarlink\" ne peuvent s'appliquer. Il peut être utilisé pour expliquer la raison de la suppression, ou pourquoi il ne peut pas être remplacé."
},
"type": "string"
},
"nocatdesc": {
"label": {
"fr": "sans description de catégorie",
"cs": "bez popisu kategorie",
"en": "nocatdesc"
},
"description": {
"fr": "la valeur yes empêche d'afficher la description de la catégorie lorsqu'une accroche est supprimée complètement de la version de MediaWiki.",
"cs": "Hodnota yes zabrání zobrazení popisu kategorie, když je upoutávka zcela odstraněna z verze MediaWiki.",
"en": "If a hook is removed completely from MediaWiki version by setting yes, it will not show up the category description."
},
"type": "string"
},
"gerritremoved": {
"label": "Gerrit changeset removed",
"description": "Gerrit change number in which this hook was removed. If this parameter is given, it'll link to the appropriate Gerrit changeset page (e.g. Gerrit change 1)",
"type": "number"
}
},
"paramOrder": [
"templatemode",
"name",
"version",
"removed",
"removed-msg",
"deprecated",
"deprecated-msg",
"newvarname",
"newvarlink",
"rev",
"gerrit",
"gerritremoved",
"summary",
"args",
"extension",
"source",
"source2",
"source3",
"source4",
"source5",
"source6",
"source7",
"source8",
"source9",
"source10",
"sourcefunction",
"sourcefunction2",
"sourceclass",
"nocatdesc"
]
}
</templatedata>
Finding a hook's version and Gerrit ID
To populate the version and gerrit attributes of this template, you may need to search the history of the docs/hooks.txt file.
- (From the top-level of a Git clone of MediaWiki source code)
- Find the oldest commit to
hooks.txtthat mentions the hook:git grep <hook-name-here> $(git rev-list --all -- docs/hooks.txt) -- docs/hooks.txt | tail -n 1
- Find its Gerrit ID:
git log <commit-from-above>
- Copy the change-id from the log entry into the Gerrit search box
- Select the relevant change, and get its ID
- Find out what release the hook was first included in:
git tag --contains <commit-from-above>
