User:NNikkhoui (WMF)/sandbox/Template:MediaWikiHook

Documentation

Copy and paste template

MyHook
Available from version ???
Define function:	public static function onMyHook( $x, $y ) { ... }
Attach hook:	In extension.json: { "Hooks": { "MyHook": "MediaWiki\\Extension\\MyExtension\\Hooks::onMyHook" } }
Called from:	File(s):
Interface:	MyHookHook.php

For more information about attaching hooks, see Manual:Hooks .
For examples of extensions using this hook, see Category:MyHook extensions.

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

Usage notes

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

Template parameters

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.	Unknown	optional
Name	name	The name of the hook. This is usually the same name as the sub-page.	Unknown	optional
Version	version	The version of MediaWiki this hook was first introduced in.	Unknown	suggested
Version removed	removed	If the hook has been removed, the version of MediaWiki that it was removed in.	String	optional
New variable name	newvarname	no description	Unknown	optional
New variable link	newvarlink	no description	Unknown	optional
Version deprecated	deprecated	If the hook has been deprecated (but not removed), the version of MediaWiki that it was deprecated in.	Unknown	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]]).	Unknown	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)	Unknown	suggested
Summary	summary	A short description of the hook's purpose. More detailed descriptions are desirable, and should be added to the main page content.	Unknown	required
Arguments	args	The arguments, as used at the top of the function.	Unknown	required
Extension	extension	no description	Unknown	optional
File source	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.	Unknown	suggested
File source 2	source2	no description	Unknown	optional
File source 3	source3	no description	Unknown	optional
File source 4	source4	no description	Unknown	optional
File source 5	source5	no description	Unknown	optional
File source 6	source6	no description	Unknown	optional
File source 7	source7	no description	Unknown	optional
File source 8	source8	no description	Unknown	optional
File source 9	source9	no description	Unknown	optional
File source 10	source10	no description	Unknown	optional
Function source	sourcefunction	Name of the function which calls this hook. Another can be added via sourcefunction2.	Unknown	suggested
Function source 2	sourcefunction2	no description	Unknown	optional
Class source	sourceclass	Name of the class which calls this hook.	Unknown	suggested

name

The name of the hook. This is usually the same name as the sub-page.

version

The version of MediaWiki this hook was first introduced in.

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).

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)

removed

If the hook has been removed, the version of MediaWiki that it was removed in.

deprecated

If the hook has been deprecated (but not removed), the version of MediaWiki that it was deprecated in.

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 Manual:Hooks .

args

The arguments, as used at the top of the function.

source

Location (file name) which calls this hook in the code. Further locations can be added via source2...source10.

sourcefunction

Name of the function which calls this hook. Another can be added via sourcefunction.

sourceclass

Name of the class which calls this hook.

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.

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.

1. (From the top-level of a Git clone of MediaWiki source code)
2. 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
3. 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
4. Find out what release the hook was first included in:
   • git tag --contains <commit-from-above>

Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Subpages of this page.