Davi: 1 revision imported

2024-04-26T05:06:24Z

1 revision imported

← Older revision	Revision as of 05:06, 26 April 2024
(No difference)

wikipedia>Pppery: Reverted edits by 166.181.253.228 (talk) to last version by SamanthaNguyen

2024-03-11T00:53:03Z

Reverted edits by 166.181.253.228 (talk) to last version by SamanthaNguyen

New page

<noinclude>
<languages />
</noinclude><includeonly>{{#switch:<translate></translate>
| =
{{#ifeq:{{{templatemode|}}}|nocats|
| {{IfNotEn|[[Category:Extension hooks{{#translation:}}|{{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|2}}}}]]}}
{{#if:{{{removed|}}}{{{gerritremoved|}}}
| {{Removed
| {{{removed}}}
| source=[[Special:MyLanguage/Extension:{{{extension}}}|{{{extension}}}]]
| newvarname={{{newvarname|}}}
| newvarlink={{{newvarlink|}}}
| deprecation version={{{deprecated|}}}
| 2={{#if:{{{gerritremoved|}}}|([[gerrit:{{{gerritremoved}}}|gerrit {{{gerritremoved}}}]])}}
}}
| {{#if:{{{deprecated|}}}{{{gerritdeprecated|}}}
| {{Deprecated
| {{{deprecated}}}
| newvarname={{{newvarname|}}}
| newvarlink={{{newvarlink|}}}
| 2={{#if:{{{gerritdeprecated|}}}|([[gerrit:{{{gerritdeprecated}}}|gerrit {{{gerritdeprecated}}}]])}}
}}
|
}}
}}
}}
<table style="text-align:{{dir|{{pagelang}}|right|left}}; border: 1px solid #a2a9b1; border-collapse: collapse; margin: auto; clear: both;" cellpadding="5">
<tr>
<th colspan="2" style="background-color: #eaecf0; font-size: 120%; text-align: center; padding: .5em;">{{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|2}}}}</th>
</tr>
<tr>
<td colspan="2" style="text-align:center;">''<translate> Available from version <tvar name=1>{{#switch:{{{version|???}}}||?|??|???|????=???|#default={{{version}}}}} {{#if:{{{rev|}}}|([[phabricator:rSVN{{{rev}}}|r{{{rev}}}]])|{{#if:{{{gerrit|}}}|([[gerrit:{{{gerrit}}}|Gerrit change {{{gerrit}}}]])}}}}</tvar></translate>''{{#if:{{{removed|}}}|<br /><strong style="font-size:110%"><translate> Removed in version <tvar name=1>{{{removed}}}</tvar></translate></strong>{{IfNotEn|[[Category:Removed extension hooks{{#translation:}}|{{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|2}}}}]]}}|}}<br />{{{summary|<translate> Please edit this page to enter a summary.</translate>}}}<br /></td>
</tr>
<tr>
<td>'''<translate> Define function:</translate>'''</td>
<td>{{#tag:syntaxhighlight|
public static function on{{replace|{{{name|{{#titleparts:{{PAGENAME}}|1|2}}}}}|[^%w]+|_|regex=yes}}( {{{args|??}}} ) { ... }
|lang="php"}}</td>
</tr>
<tr>
<td>'''<translate> Attach hook:</translate>'''</td>
<td>{{#tag:syntaxhighlight|
$wgHooks['{{{name|{{#titleparts:{{PAGENAME}}|1|2}}}}}'][] = 'MyExtensionHooks::on{{replace|{{{name|{{#titleparts:{{PAGENAME}}|1|2}}}}}|[^%w]+|_|regex=yes}}';
|lang="php"}}</td>
</tr>
<tr>
<td style="padding:0.3em">'''<translate> Called from:</translate>'''</td><td>'''<translate> File(s):</translate>'''{{#if:{{{extension|}}}|<nowiki> </nowiki>[[Category:Extension hooks provided by {{{extension}}}]][[Special:MyLanguage/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> Function(s):</translate>''' {{#if: {{{sourceclass|}}}|{{class doclink|class={{{sourceclass}}}|text={{{sourcefunction}}}}}|{{{sourcefunction}}}}}{{#if: {{{sourcefunction2|}}}|, {{{sourcefunction2}}}}}}}</td>
</tr>
</table>
<div style="text-align:center">
''<translate> For more information about attaching hooks, see <tvar name=1>{{ll|Manual:Hooks}}</tvar>.</translate>''
<br />
{{#if:{{{nocatdesc|}}}||''<translate> For examples of other extensions using this hook, see <tvar name=cat>[[:Category:{{#if:{{{name|}}}|{{{name}}}|{{#titleparts:{{PAGENAME}}|1|3}}}} extensions{{#translation:}}]]</tvar>.</translate>''}}
</div>
| #default=
{{#invoke:Template translation|renderTranslatedTemplate|template=Template:ExtensionHook|noshift=1|uselang={{int:lang}}}}
}}</includeonly><noinclude>
{{Documentation|content=
<translate>
== Copy and paste template == 
</translate>
{{ExtensionHook|templatemode=nocats
|name = MyHook
|version =
|gerrit =
|removed =
|summary =
|args = $x, $y
|extension =
|source =
|sourcefunction =
|sourceclass =
|newvarname =
|newvarlink =
|nocatdesc =
}}
<pre>
{{ExtensionHook
|name = MyHook
|version =
|gerrit =
|removed =
|summary =
|args = $x, $y
|extension =
|source =
|sourcefunction =
|sourceclass =
|newvarname =
|newvarlink =
|nocatdesc =
}}
</pre>

<translate>
== Usage notes == 
</translate>
;name
: <translate> The name of the hook.</translate> <translate> This is usually the same name as the sub-page.</translate>

;version
: <translate> The version of MediaWiki this hook was first introduced in.</translate>

;rev
: <translate> SVN revision in which this hook was first introduced.</translate> <translate> If this parameter is given, it will link to the appropriate CodeReview page (e.g. <tvar name=1>[[phabricator:rSVN115794|r115794]]</tvar>).</translate>

;gerrit
: <translate> Gerrit change number in which this hook was first introduced.</translate> <translate> If this parameter is given, it will link to the appropriate Gerrit changeset page (e.g., [[<tvar name=1>gerrit:5</tvar>|Gerrit change 5]])</translate>

;removed
: <translate> If the hook has been removed, the version of MediaWiki that it was removed in.</translate>

;deprecated
: <translate> If the hook has been deprecated (but not removed), the version of MediaWiki that it was deprecated in.</translate>

;summary
: <translate> A short description of the hook's purpose.</translate>
: <translate> More detailed descriptions are desirable, and should be added to the main page content.</translate>
: <translate> If you update the short description, please also update the two tables on <tvar name=man>{{ll|Manual:Hooks}}</tvar>.</translate>

;args
: <translate> The arguments, as used at the top of the function.</translate>

;extension
: Extension name where hook is called; for when the '''source''' is not in the MediaWiki core code repository.

;source
: <translate> Location (file name) which calls this hook in the code. Further locations can be added via <tvar name=1>'''source2'''...'''source10'''</tvar>.</translate>

;sourcefunction
: <translate> Name of the function which calls this hook. Another can be added via <tvar name=1>'''sourcefunction2'''</tvar>.</translate>

;sourceclass
: <translate> Name of the class which calls this hook.</translate>

;newvarname
: <translate> Used by <tvar name=1>{{tl|Removed}}</tvar> or <tvar name=2>{{tl|Deprecated}}</tvar> when <tvar name=3>'''removed'''</tvar> or <tvar name=4>'''deprecated'''</tvar> is set.</translate>

;newvarlink
: <translate> Used by <tvar name=1>{{tl|Removed}}</tvar> or <tvar name=2>{{tl|Deprecated}}</tvar> when <tvar name=3>'''removed'''</tvar> or <tvar name=4>'''deprecated'''</tvar> is set.</translate>

;templatemode
: <translate> Set to <tvar name=nocats>'''nocats'''</tvar> if hook documentation should not appear in standard MediaWiki Categories.</translate>
: <translate> By default, using this template places the documentation page into categories:</translate>
:* <translate> MediaWiki hooks</translate>
:* <translate> Hooks added in MediaWiki...</translate>
: <translate> There are times when it is undesirable to automatically categorise the hook documentation.</translate> <translate> Examples would include when documenting a hook in an extension, or when documenting the template itself.</translate>
; nocatdesc
: <translate> If a hook is removed completely from MediaWiki version by setting <tvar name=1><code>yes</code></tvar>, it will not show up the category description.</translate>

== Template data ==
{{ExtensionHook/doc}}

<translate>
== See also== 
</translate>
* {{ll|Template:MediaWikiHook}}

}}

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

Template:ExtensionHook - Revision history

Davi: 1 revision imported

wikipedia>Pppery: Reverted edits by 166.181.253.228 (talk) to last version by SamanthaNguyen