Template:MediaWikiHook

'' For more information about attaching hooks, see . ''

'' For examples of extensions using this hook, see Category: extensions. '' {{Documentation|content=

Usage notes

 * 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. 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. [https://gerrit.wikimedia.org/r/#/c/1/ 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 .


 * 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   and   attributes of this template, you may need to search the history of the <tvar|3></> file.


 * 1) ( From the top-level of a Git clone of MediaWiki source code )
 * 2) Find the oldest commit to <tvar|1> </> that mentions the hook:
 * 3) Find its Gerrit ID:
 * 4) Copy the change-id from the log entry into the Gerrit search box
 * 5) Select the relevant change, and get its ID
 * 6) Find out what release the hook was first included in:
 * 1) Select the relevant change, and get its ID
 * 2) Find out what release the hook was first included in:

}}