Шаблон:ExtensionHook

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

Скопируйте и вставьте шаблон

MyHook
Доступен с версии ???
Определяет функцию:	public static function onMyHook( $x, $y ) { ... }
Присоединяет хук:	$wgHooks['MyHook'][] = 'MyExtensionHooks::onMyHook';
Вызывается из:	Файл(ы)

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

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

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

name

Название хука. Обычно это то же имя, что и подстраница.

version

Версия MediaWiki, в которой этот хук был впервые представлен.

rev

Версия SVN, в которой этот хук был впервые представлен. Если указан этот параметр, он будет ссылаться на соответствующую страницу CodeReview (например, r115794).

gerrit

Номер изменения Gerrit, в котором этот хук был впервые представлен. Если указан этот параметр, он будет ссылаться на соответствующую страницу изменений Gerrit (например, Gerrit change 5)

removed

Если хук был удалён, версия MediaWiki, в которой он был удален.

deprecated

Если хук устарел (но не удалён), версия MediaWiki, в которой он устарел.

summary

Краткое описание цели хука.

Более подробные описания желательны, и должны быть добавлены к содержанию главной страницы.

Если вы обновите краткое описание, пожалуйста, обновите две таблицы на Руководство:Прерывания (хуки) .

args

Аргументы, используемые в верхней части функции.

extension

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

source

Местоположение (имя файла), которое вызывает этот хук в коде. Другие местоположения могут быть добавлены через source2...source10.

sourcefunction

Имя функции, которую вызывает этот хук. Еще можно добавить через sourcefunction2.

sourceclass

Имя класса, который вызывает этот хук.

newvarname

Используйте {{Удалено }} или {{Устаревший }}, когда установлены removed или deprecated.

newvarlink

Используйте {{Удалено }} или {{Устаревший }}, когда установлены removed или deprecated.

templatemode

Установите значение nocats, если документация о хуке не должна появляться в стандартных категориях MediaWiki.

По умолчанию использование этого шаблона размещает страницу документации в категориях:

• MediaWiki хуки
• Хуки добавленные в MediaWiki...

В некоторых случаях нежелательно автоматически классифицировать документацию о хуках. Примерами могут служить документирование хука в расширении или документирование самого шаблона.

nocatdesc

If a hook is removed completely from MediaWiki version by setting yes, it will not show up the category description.

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.

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

Смотрите также

• Шаблон:MediaWikiHook

Редакторы могут поэкспериментировать в песочнице (создать | зеркало) или тестовый (создать).
Посмотреть все подстраницы этого шаблона.