View source for Template:MediaWikiHook/en

<noinclude>
<languages/>
</noinclude><includeonly>{{#ifeq:{{{templatemode|}}}|nocats|
  |[[Category:MediaWiki hooks{{#translation:}}|{{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|2}}}}]]
[[Category:Hooks added in MediaWiki {{#switch:{{{version|???}}}||?|??|???|????=???|#default={{{version}}}}}{{#translation:}}|{{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|2}}}}]]
{{#if:{{{removed|}}}
  |{{Removed|{{{removed}}}|{{{removed-msg|}}}|newvarname={{{newvarname|}}}|newvarlink={{{newvarlink|}}}|name={{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|2}} }}|deprecated={{{deprecated|}}} }}
  |{{#if:{{{deprecated|}}}
    |{{Deprecated|{{{deprecated}}}|{{{deprecated-msg|}}}|newvarname={{{newvarname|}}}|newvarlink={{{newvarlink|}}}|name={{#if:{{{name|}}}|{{{name}}}|{{#if:{{{deprecated-msg|{{#titleparts:{{PAGENAME}}|1|2}}}}}}} }} }}
    |
    }}
  }}
{{#if:{{{removed|}}}   |[[Category:Hooks removed in MediaWiki {{{removed}}}{{#translation:}}|{{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|2}}}}]]}}
{{#if:{{{deprecated|}}}|[[Category:Hooks deprecated in MediaWiki {{{deprecated}}}{{#translation:}}|{{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|2}}}}]]}}
}}
{| style="text-align: {{dir|{{PAGELANGUAGE}}|right|left}}; border: 1px solid #a2a9b1; border-collapse: collapse; margin: auto; clear: both;" cellpadding="5"
|-
! colspan="2" style="background-color: #eaecf0; font-size: 120%; text-align: center; padding: .5em;" | {{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|2}}}}
|-
| colspan="2" style="text-align:center;" | <i>{{#ifexist:MediaWiki {{padleft:|4|{{{version|???}}}}}
  |Available from [[Special:MyLanguage/MediaWiki {{padleft:|4|{{{version|???}}}}}|{{Version|lc=1|1={{#switch:{{{version|???}}}||?|??|???|????=???|#default={{{version}}}}} }}]] {{#if:{{{rev|}}}|([[phabricator:rSVN{{{rev}}}|r{{{rev}}}]], [https://static-codereview.wikimedia.org/MediaWiki/{{{rev}}}.html CodeReview archive])|{{#if:{{{gerrit|}}}|([[gerrit:q/{{{gerrit}}}|Gerrit change {{{gerrit}}}]])}}}}
  |Available from {{Version|lc=1|1={{#switch:{{{version|???}}}||?|??|???|????=???|#default={{{version}}}}} }} {{#if:{{{rev|}}}|([[phabricator:rSVN{{{rev}}}|r{{{rev}}}]], [https://static-codereview.wikimedia.org/MediaWiki/{{{rev}}}.html CodeReview archive])|{{#if:{{{gerrit|}}}|([[gerrit:q/{{{gerrit}}}|Gerrit change {{{gerrit}}}]])}}}}
  }}</i><!--/#ifexist-->{{#if:{{{removed|}}}|<br /><strong style="font-size:110%">{{#ifexist:MediaWiki {{padleft:|4|{{{removed|???}}}}}
  |Removed in [[Special:MyLanguage/MediaWiki {{padleft:|4|{{{removed}}}}}|{{Version|lc=1|1={{{removed}}} }}]] {{#if:{{{gerritremoved|}}}|([[gerrit:q/{{{gerritremoved}}}|Gerrit change {{{gerritremoved}}}]])}}
  |Removed in {{Version|lc=1|1={{{removed}}} }} {{#if:{{{gerritremoved|}}}|([[gerrit:q/{{{gerritremoved}}}|Gerrit change {{{gerritremoved}}}]])}}
}}</strong>{{IfNotEn|[[Category:Removed hooks{{#translation:}}|{{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|2}}}}]]}}|}}<br />{{{summary|Please edit this page to enter a summary.}}}<br />
|-
| '''Define function:'''
| {{#tag:syntaxhighlight|
public static function on{{replace|{{{name|{{#titleparts:{{PAGENAME}}|1|2}}}}}|[^%w]+|_|regex=yes}}( {{{args|??}}} ) { ... }
|lang="php"}}
|-
| style="vertical-align:top"|'''Attach hook:'''
| In {{manual|extension.json}}:
{{#tag:syntaxhighlight|
{
	"Hooks": {
		"{{{name|{{#titleparts:{{PAGENAME}}|1|2}}}}}": "MediaWiki\\Extension\\MyExtension\\Hooks::on{{replace|{{{name|{{#titleparts:{{PAGENAME}}|1|2}}}}}|[^%w]+||regex=yes}}"
	}
}
|lang="json"}}
|-
| style="padding:0.3em" | '''Called from:'''
| '''File(s):'''{{#if:{{{extension|}}}|<nowiki> </nowiki>[[Extension:{{{extension}}}|{{{extension}}}]] /}} {{Foreach|MediaWikiHook/{{#ifeq:{{{templatemode|{{#if:{{{extension|}}}|nocats|}}}}}|nocats|SourceNoCats|Source}}|delim=, <nowiki/>|{{{source|}}}|{{{source2|}}}|{{{source3|}}}|{{{source4|}}}|{{{source5|}}}|{{{source6|}}}|{{{source7|}}}|{{{source8|}}}|{{{source9|}}}|{{{source10|}}} }}{{#if: {{{sourcefunction|}}}|<br />'''Function(s):''' {{#if: {{{sourceclass|}}}|{{class doclink|class={{{sourceclass}}}|text={{{sourcefunction}}}}}|{{{sourcefunction}}}}}{{#if: {{{sourcefunction2|}}}|, {{{sourcefunction2}}}}}}}
|-
| '''Interface:'''
| {{#if:{{{name|}}}|[https://doc.wikimedia.org/mediawiki-core/master/php/{{ucfirst:{{replace|{{replace|{{{name}}}|_|__}}|:|__}}}}Hook_8php.html {{replace|{{{name}}}|:|_}}Hook.php]|[https://doc.wikimedia.org/mediawiki-core/master/php/{{ucfirst:{{#titleparts:{{PAGENAME}}|1|2}}}}Hook_8php.html {{ucfirst:{{#titleparts:{{PAGENAME}}|1|2}}Hook.php]}}}}
|}
<div style="text-align:center">
''For more information about attaching hooks, see {{ll|Manual:Hooks}}.''
<br />
{{#if:{{{nocatdesc|}}}||''For examples of extensions using this hook, see [[:Category:{{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|2}}}} extensions{{#translation:}}]].''}}
</div>
</includeonly><noinclude>
{{Documentation|content=
== Copy and paste template ==
{{MediaWikiHook|templatemode=nocats
|name = MyHook
|version =
|gerrit =
|removed =
|gerritremoved =
|summary =
|args = $x, $y
|source =
|sourcefunction =
|sourceclass =
|newvarname =
|newvarlink =
|nocatdesc =
}}
<pre>
{{MediaWikiHook
|name = MyHook
|version =
|gerrit =
|gerritremoved =
|removed =
|summary =
|args = $x, $y
|source =
|sourcefunction =
|sourceclass =
|newvarname =
|newvarlink =
|nocatdesc =
}}
</pre>

== Usage notes ==

{{MediaWikiHook/doc}}

== Finding a hook's version and Gerrit ID ==

To populate the <code>version</code> and <code>gerrit</code> attributes of this template, you may need to search the history of the {{git file|file=docs/hooks.txt}} file.

# (From the top-level of a Git clone of MediaWiki source code)
# Find the oldest commit to <code>hooks.txt</code> that mentions the hook:
#* <code>git grep <span style="color:orange"><hook-name-here></span> $(git rev-list --all -- docs/hooks.txt) -- docs/hooks.txt {{!}} tail -n 1</code>
# Find its Gerrit ID:
#* <code>git log <span style="color:orange"><commit-from-above></span></code>
## Copy the change-id from the log entry into the Gerrit search box
## Select the relevant change, and get its ID
# Find out what release the hook was first included in:
#* <code>git tag --contains <span style="color:orange"><commit-from-above></span></code>

== Categories ==

The template automatically adds the page to the following categories:
* <code>Category:Hooks added in MediaWiki <version></code>
* <code>Category:MediaWiki hooks included in <file></code>

and links to the following category:
* <code>Category:<hook name> extensions</code>

When creating a new hook documentation page, you should create this categories if they don't exist yet. The first two can be left with an empty body; the third one should contain <code><nowiki>{{HookUsage|<name>}}</nowiki></code>.

}}<!-- end of Documentation template -->

[[Category:Infobox templates{{#translation:}}|{{PAGENAME}}]]
[[Category:Categorizing templates{{#translation:}}|{{PAGENAME}}]]
[[Category:Hook templates{{#translation:}}|{{PAGENAME}}]]
</noinclude>