Template:ExtensionHook

{{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 will link to the appropriate CodeReview page (e.g. r115794).


 * 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 (e.g., 1>gerrit:5|Gerrit change 5)


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


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


 * 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 sourcefunction2.


 * sourceclass
 * Name of the class which calls this hook.


 * newvarname
 * Used by Removed or Deprecated when removed or deprecated</> is set.


 * newvarlink
 * Used by <tvar|1>Removed</> or <tvar|2>Deprecated</> when <tvar|3>removed</> or <tvar|4>deprecated</> is set.


 * templatemode
 * Set to <tvar|nocats>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.

Template data
{	"params": { "templatemode": { "label": "Template mode", "type": "string" },		"name": { "label": "Name", "description": "The name of the hook. This is usually the same name as the sub-page.", "type": "string", "required": true },		"removed": { "label": "Version removed", "description": "If the hook has been removed, the version of MediaWiki that it was removed in.", "type": "string" },		"newvarname": { "label": "Replacement name", "description": "If the hook is either deprecated or removed, name the feature that replaces this hook, if there is any replacement.", "type": "string" },		"newvarlink": { "label": "Replacement link", "description": "If the hook is either deprecated or removed, link to the feature that replaces this hook, if there is any replacement.", "type": "wiki-page-name" },		"deprecated": { "label": "Version deprecated", "description": "If the hook has been deprecated, the version of MediaWiki that it was deprecated in.", "type": "string" },		"version": { "label": "Version introduced", "description": "The version of MediaWiki this hook was first introduced in.", "type": "string", "suggested": true },		"rev": { "label": "SVN revision introduced", "description": "SVN revision in which this hook was first introduced. If this parameter is given, it will link to the appropriate CodeReview page.", "type": "string" },		"gerrit": { "label": "Gerrit changeset introduced", "description": "Gerrit change number in which this hook was first introduced. If this parameter is given, it will link to the appropriate Gerrit changeset page.", "type": "number", "suggested": true },		"summary": { "label": "Summary", "description": "A short description of the hook's purpose. More detailed descriptions are desirable, and should be added to the main page content.", "type": "string", "suggested": true },		"args": { "label": "Arguments", "description": "The arguments that are defined by the hook signature.", "required": true, "type": "string" },		"extension": { "label": "Extension name", "description": "Extension name where the hook is called; for when the source is not in the Mediawiki core code repository.", "type": "wiki-page-name", "required": true },		"source": { "label": "Source 1", "description": "Location (file name) which calls this hook in the code.", "type": "string", "suggested": true },		"source2": { "label": "Source 2", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source3": { "label": "Source 3", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source4": { "label": "Source 4", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source5": { "label": "Source 5", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source6": { "label": "Source 6", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source7": { "label": "Source 7", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source8": { "label": "Source 8", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source9": { "label": "Source 9", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"source10": { "label": "Source 10", "description": "Location (file name) which calls this hook in the code, if another source exists", "type": "string" },		"sourcefunction": { "label": "Source function", "description": "Name of the function which calls this hook", "type": "string", "suggested": true },		"sourceclass": { "label": "Source class", "description": "The fully qualified class name (FQCN) which calls this hook.", "suggested": true, "type": "string" },		"sourcefunction2": { "label": "Source function 2", "description": "Name of the function which calls this hook, if another functions call this hook", "type": "string" }	},	"description": "A card which describes the information of a hook registered by an extension.", "paramOrder": [ "templatemode", "name", "rev", "gerrit", "version", "deprecated", "removed", "newvarname", "newvarlink", "summary", "args", "extension", "source", "source2", "source3", "source4", "source5", "source6", "source7", "source8", "source9", "source10", "sourceclass", "sourcefunction", "sourcefunction2" ],	"format": "block" }