Шаблон:MediaWikiHook

This page is a translated version of the page Template:MediaWikiHook and the translation is 50% complete.

Документация шаблона

Копирование и вставка шаблона

MyHook
Доступен с version ???
Определяет функцию:	public static function onMyHook( $x, $y ) { ... }
Прикрепить хук:	В extension.json: { "Hooks": { "MyHook": "MediaWiki\\Extension\\MyExtension\\Hooks::onMyHook" } }
Вызывается из:	Файла(Файлов):
Interface:	MyHookHook.php

Для получения дополнительной информации о присоединении перехватчиков, см Руководство:Прерывания (хуки) .
Примеры расширений с использованием этого хука см. в Category:MyHook extensions/ru.

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

Примечания по использованию

Это документация TemplateData для этого шаблона, используемого VisualEditor и другими инструментами.

MediaWikiHook

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

Template parameters[Edit template data]
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Template mode	`templatemode`	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.	String	optional
Name	`name`	The name of the hook. This is usually the same name as the sub-page.	String	optional
Version	`version`	The version of MediaWiki this hook was first introduced in. Should always be a full version number (ie. ending with ".0"). Example 1.35.0	String	suggested
Version removed	`removed`	If the hook has been removed, the version of MediaWiki that it was removed in.	String	optional
Message for removed hook	`removed-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.	String	optional
Version deprecated	`deprecated`	If the hook has been deprecated (but not removed), the version of MediaWiki that it was deprecated in.	String	optional
Message for deprecated hook	`deprecated-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.	String	optional
New variable name	`newvarname`	For removed or deprecated hooks, the name of the hook that should be used instead	String	optional
New variable link	`newvarlink`	For removed or deprecated hooks, the link to the hook that should be used instead	Page name	optional
SVN revision introduced	`rev`	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]]). Example [[phabricator:rSVN1]]	URL	optional
Gerrit changeset	`gerrit`	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)	Number	suggested
Gerrit changeset removed	`gerritremoved`	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)	Number	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. If you update the short description, please also update the two tables on [[Special:MyLanguage/Manual:Hooks]].	String	required
Arguments	`args`	The arguments, as used at the top of the function.	String	required
extension	`extension`	The extension which defines this hook.	String	optional
File source 1	`source`	Location (file name/path not including <code>includes/</code>) which calls this hook in the code. Further locations can be added via source2...source10.	File	suggested
File source 2	`source2`	see source	File	optional
File source 3	`source3`	see source	File	optional
File source 4	`source4`	see source	File	optional
File source 5	`source5`	see source	File	optional
File source 6	`source6`	see source	File	optional
File source 7	`source7`	see source	File	optional
File source 8	`source8`	see source	File	optional
File source 9	`source9`	see source	File	optional
File source 10	`source10`	see source	File	optional
Function source 1	`sourcefunction`	Name of the function which calls this hook. Another can be added via sourcefunction2.	String	suggested
Function source 2	`sourcefunction2`	see sourcefunction	String	optional
Class source	`sourceclass`	Name of the class which calls this hook.	String	suggested
nocatdesc	`nocatdesc`	If a hook is removed completely from MediaWiki version by setting yes, it will not show up the category description.	String	optional

Поиск версии хука и Gerrit ID

Чтобы заполнить атрибуты version и gerrit этого шаблона, вам может потребоваться поискать в истории файла docs/hooks.txt.

(From the top-level of a Git clone of MediaWiki source code)
Find the oldest commit to hooks.txt that 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>
1. Copy the change-id from the log entry into the Gerrit search box
2. Select the relevant change, and get its ID
Find out what release the hook was first included in:
- git tag --contains <commit-from-above>

Копирование и вставка шаблона

Примечания по использованию

Поиск версии хука и Gerrit ID

Categories