View source for Template:MediaWikiHook

<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; margin:0.3em" | <i>{{#ifexist:MediaWiki {{padleft:|4|{{{version|???}}}}}
  |<translate><!--T:1--> Available from <tvar name=1>[[Special:MyLanguage/MediaWiki {{padleft:|4|{{{version|???}}}}}|{{Version|lc=1|1={{#switch:{{{version|???}}}||?|??|???|????=???|#default={{{version}}}}} }}]] {{#if:{{{rev|}}}|([[phabricator:rSVN{{{rev}}}|r{{{rev}}}]])|{{#if:{{{gerrit|}}}|([[gerrit:q/{{{gerrit}}}|Gerrit change {{{gerrit}}}]])}}}}</tvar></translate>
  |<translate><!--T:53--> Available from <tvar name=1>{{Version|lc=1|1={{#switch:{{{version|???}}}||?|??|???|????=???|#default={{{version}}}}} }} {{#if:{{{rev|}}}|([[phabricator:rSVN{{{rev}}}|r{{{rev}}}]])|{{#if:{{{gerrit|}}}|([[gerrit:q/{{{gerrit}}}|Gerrit change {{{gerrit}}}]])}}}}</tvar></translate>
  }}</i><!--/#ifexist-->{{#if:{{{removed|}}}|<br /><strong style="font-size:110%">{{#ifexist:MediaWiki {{padleft:|4|{{{removed|???}}}}}
  |<translate><!--T:2--> Removed in <tvar name=1>[[Special:MyLanguage/MediaWiki {{padleft:|4|{{{removed}}}}}|{{Version|lc=1|1={{{removed}}} }}]] {{#if:{{{gerritremoved|}}}|([[gerrit:q/{{{gerritremoved}}}|Gerrit change {{{gerritremoved}}}]])}}</tvar></translate>
  |<translate><!--T:54--> Removed in <tvar name=1>{{Version|lc=1|1={{{removed}}} }} {{#if:{{{gerritremoved|}}}|([[gerrit:q/{{{gerritremoved}}}|Gerrit change {{{gerritremoved}}}]])}}</tvar></translate>
}}</strong>{{IfNotEn|[[Category:Removed hooks{{#translation:}}|{{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|2}}}}]]}}|}}<br />{{{summary|<translate><!--T:3--> Please edit this page to enter a summary.</translate>}}}<br />
|-
| '''<translate><!--T:4--> Define function:</translate>'''
| {{#tag:syntaxhighlight|
public static function on{{replace|{{{name|{{#titleparts:{{PAGENAME}}|1|2}}}}}|[^%w]+|_|regex=yes}}( {{{args|??}}} ) { ... }
|lang="php"}}
|-
| style="vertical-align:top"|'''<translate><!--T:5--> Attach hook:</translate>'''
| <translate><!--T:49--> In <tvar name=1>{{manual|extension.json}}</tvar>:</translate>
{{#tag:syntaxhighlight|
{
	"Hooks": {
		"{{{name|{{#titleparts:{{PAGENAME}}|1|2}}}}}": "MyExtensionHooks::on{{replace|{{{name|{{#titleparts:{{PAGENAME}}|1|2}}}}}|[^%w]+||regex=yes}}"
	}
}
|lang="json"}}
|-
| style="padding:0.3em" | '''<translate><!--T:6--> Called from:</translate>'''
| '''<translate><!--T:7--> File(s):</translate>'''{{#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 />'''<translate><!--T:10--> Function(s):</translate>''' {{#if: {{{sourceclass|}}}|{{class doclink|class={{{sourceclass}}}|text={{{sourcefunction}}}}}|{{{sourcefunction}}}}}{{#if: {{{sourcefunction2|}}}|, {{{sourcefunction2}}}}}}}
|-
| '''<translate><!--T:51--> Interface:</translate>'''
| {{#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">
''<translate><!--T:8--> For more information about attaching hooks, see <tvar name=1>{{ll|Manual:Hooks}}</tvar>.</translate>''
<br />
{{#if:{{{nocatdesc|}}}||''<translate><!--T:9--> For examples of extensions using this hook, see <tvar name=cat>[[:Category:{{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|2}}}} extensions{{#translation:}}]]</tvar>.</translate>''}}
</div>
</includeonly><noinclude>
{{Documentation|content=
<translate>
== Copy and paste template == <!--T:11-->
</translate>
{{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>

<translate>
== Usage notes == <!--T:12-->
</translate>

{{MediaWikiHook/doc}}

<translate>
== Finding a hook's version and Gerrit ID == <!--T:38-->

<!--T:39-->
To populate the <tvar name=1><code>version</code></tvar> and <tvar name=2><code>gerrit</code></tvar> attributes of this template, you may need to search the history of the <tvar name=3>{{git file|file=docs/hooks.txt}}</tvar> file.
</translate>

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

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

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