View source for Extensions FAQ

<languages/>
[[File:MediaWiki-extensions-icon.svg|125px|alt=<translate><!--T:1--> MediaWiki extensions</translate>|right]]

<translate>
==Where can I find a list of installed extensions?== <!--T:2-->
</translate>
<translate>The <tvar name="1">[[Special:Version]]</tvar> page on each wiki contains a list of extensions that have registered themselves with the <tvar name="2">[[MediaWiki]]]</tvar> software.</translate>
<translate><!--T:35--> All extensions can be installed without showing up on <tvar name=1>[[Special:Version]]</tvar>, if the developer does not [[<tvar name=2>#How do I get my extension to show up on Special:Version?</tvar>|include the correct code]] to list it there.</translate>

<translate>

==How do I enable an extension?== <!--T:3-->
</translate>
<translate>For most extensions, copy the extension PHP file (or directory) to your <tvar name="1"><code>extensions/</code></tvar> folder and add the following statement to your <tvar name="2"><code>{{ll|Manual:LocalSettings.php|LocalSettings.php}}</code></tvar>, with <tvar name="3"><code>ExtensionName</code></tvar> being the filename of your extension, such as ''MyExtension.php''.</translate>

<syntaxhighlight lang="php">
require_once "extensions/ExtensionName/ExtensionName.php";
</syntaxhighlight>

<translate>Since <tvar name="1">[[MediaWiki 1.25|1.25]]</tvar> (2015), there is a new way of installing extensions, which works with extensions that support [[<tvar name="2">Manual:Extensions</tvar>|extension registration]].</translate>
<translate><!--T:4--> The equivalent for the extension above would be:</translate>

<syntaxhighlight lang="php">
wfLoadExtension('ExtensionName');
</syntaxhighlight>

<translate><!--T:5--> Some extensions, however, have additional steps and/or different installation procedures.</translate>
<translate>Some extensions will contain a text-file named <tvar name="1"><code>README</code></tvar> (sometimes <tvar name="2"><code>INSTALL</code></tvar>) that will have more detailed information about that extension.</translate>

<translate><!--T:6--> See also:</translate>
''{{ll|Manual:Extensions#Installing an extension|2=<translate><!--T:32--> Manual:Extensions#Installing an extension</translate>}}''

<translate>

==How do I write my own extension?== <!--T:7-->

<!--T:33-->
See <tvar name=1>{{ll|Manual:Developing extensions}}</tvar>.

==How do I disable caching for pages using my extension?== <!--T:8-->

<!--T:9-->
If you're writing e.g. special page:
</translate>

<syntaxhighlight lang="php">
global $wgOut;
$wgOut->enableClientCache(false);
</syntaxhighlight>

<translate>
<!--T:10-->
For parser tag hooks:
</translate>

<syntaxhighlight lang="php">
function wfSomeHookFunction( $parser, $foo, $bar ) {
    $parser->getOutput()->updateCacheExpiry(0);
    ...
}
</syntaxhighlight>

<translate><!--T:11--> In case your extension output is only dependent on some option or user context and not time, you can still let it get cached by the parser cache but make sure it's marked as one output variant (of many possible).</translate>
<translate>Use the [[<tvar name="1">Manual:Hooks/PageRenderingHash</tvar>|PageRenderingHash]] hook to influence the cache hash accordingly.</translate>

(<translate>Note that in older versions of MediaWiki, you would use <tvar name="1"><code>$parser->disableCache()</code></tvar> to disable caching, but this was deprecated in MW 1.28 and removed altogether in MW 1.35.</translate>)

<translate>

==How do I render wikitext in my extension?== <!--T:12-->

===Special pages=== <!--T:13-->

<!--T:14-->
When rendering output that will not be subject to parser cache, such as on a special page
</translate>

<syntaxhighlight lang="php">
global $wgOut;
$wgOut->parse( $text );
</syntaxhighlight>

<translate>where <tvar name="1"><code>$text</code></tvar> is the wikitext to be parsed.</translate>

<translate>

===Parser hooks=== <!--T:15-->
</translate>
''<translate><!--T:34--> See [[<tvar name=1>Special:MyLanguage/Manual:Tag extensions#How do I render wikitext in my extension?</tvar>|Manual:Tag extensions#How do I render wikitext in my extension?]]</translate>''

<translate>
==How do I enable searching in my extension's output (dynamic content)?== <!--T:16-->

<!--T:17-->
You can't. Dynamic content can not be included in a static index.

==How can I avoid modification of my extension's HTML output?== <!--T:18-->
</translate>
''<translate>See [[<tvar name="1">Manual:Tag extensions#How can I avoid modification of my extension's HTML output?</tvar>|Manual:Tag extensions#How can I avoid modification of my extension's HTML output?]]</translate>''

<translate>

==How can I pass XML-style parameters in my extension tag?== <!--T:19-->
</translate>
''See [[Manual:Tag extensions#How can I pass XML-style parameters in my extension tag?]]''

<translate>
==Extensions and Templates== <!--T:20-->
</translate>
''See [[Manual:Tag extensions#Extensions and Templates]]''

<translate>
=="NaodW..." or "UNIQ..."== <!--T:21-->
</translate>

Your extension (or another one installed) might be using <code>parse()</code> function instead of <code>recursiveTagParse()</code>.
Then change it to <code>recursiveTagParse</code> ''(using the parser given in parameter or $wgParser)''.

<translate>
==How can I determine in my extension, if an article is protected or not?== <!--T:24-->
</translate>
'''Use the Title class and the isProtected( ) method, e.g.'''

<syntaxhighlight lang="php">
function extensionFunction() {
   # <translate nowrap><!--T:25--> Assume <tvar name=1>$title</tvar> is the title object</translate>
   if( $title->isProtected( 'edit' ) ) {
      # <translate nowrap><!--T:26--> Protected from editing, do things</translate>
   } else {
      # <translate nowrap><!--T:27--> Not protected from editing</translate>
   }
}
</syntaxhighlight>

<translate>
==What permissions do I apply to the extensions folder?== <!--T:28-->
</translate>
<translate><!--T:29--> All the scripts in the <tvar name=1>/wiki</tvar> structure need to be readable and executable by the user that PHP runs as.</translate>
<translate><!--T:30--> All perms are usually <tvar name=1>755</tvar> and owner/group being a ''different'' user.</translate>
<translate><!--T:36--> The <tvar name=1>LocalSettings.php</tvar> file is created by the script on setup and so will be an example to set the rest by.</translate>

<translate>
==How do I get my extension to show up on Special:Version?== <!--T:31-->
</translate>
''See [[Manual:Developing extensions#Registering features with MediaWiki]]''

{{Extensions}}

[[Category:Extensions{{#translation:}}| ]]