Шаблон:ExtensionHook

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Template:ExtensionHook and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎dansk • ‎français • ‎polski • ‎русский • ‎العربية • ‎中文 • ‎日本語
Документация шаблона

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

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 =
}}

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

name
Название хука. Обычно это то же имя, что и подстраница.
version
Версия MediaWiki, в которой этот хук был впервые представлен.
rev
Версия SVN, в которой этот хук был впервые представлен. Если указан этот параметр, он будет ссылаться на соответствующую страницу CodeReview (например, r115794).
gerrit
Номер изменения Gerrit, в котором этот хук был впервые представлен. Если указан этот параметр, он будет ссылаться на соответствующую страницу изменений Gerrit (например, Gerrit change 5)
removed
Если хук был удалён, версия MediaWiki, в которой он был удален.
deprecated
Если хук устарел (но не удалён), версия MediaWiki, в которой он устарел.
summary
Краткое описание цели хука.
Более подробные описания желательны, и должны быть добавлены к содержанию главной страницы.
Если вы обновите краткое описание, пожалуйста, обновите две таблицы на Manual:Hooks .
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}}, когда установлены removed или deprecated.
newvarlink
Используйте {{Removed}} или {{Deprecated}}, когда установлены removed или deprecated.
templatemode
Установите значение nocats, если документация о хуке не должна появляться в стандартных категориях MediaWiki.
По умолчанию использование этого шаблона размещает страницу документации в категориях:
  • MediaWiki хуки
  • Хуки добавленные в MediaWiki...
В некоторых случаях нежелательно автоматически классифицировать документацию о хуках. Примерами могут служить документирование хука в расширении или документирование самого шаблона.

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