View source for Manual:$wgUrlProtocols/de-formal

<languages/>
{{SettingSummary
|name=UrlProtocols
|version_min=1.5.0
|rev_introduced=10229
|section=Parser
|range=(<span lang="en" dir="ltr" class="mw-content-ltr">array of strings</span>) (1.6+)<br />
(<span lang="en" dir="ltr" class="mw-content-ltr">string containing a regular expression</span>) (1.5)
|default=''<span lang="en" dir="ltr" class="mw-content-ltr">see below</span>''
|summary=<span lang="en" dir="ltr" class="mw-content-ltr">Defines the protocols which are supported and translated in HTML by the mediawiki parser.</span>
}}
__NOTOC__
== Details ==
<span lang="en" dir="ltr" class="mw-content-ltr">Defines the URL protocols that MediaWiki will recognize as valid in wfParseUrl().</span>  
<span lang="en" dir="ltr" class="mw-content-ltr">This is used in lots of places.</span>  
<span lang="en" dir="ltr" class="mw-content-ltr">The most visible effect is it determines what protocols are allowed for external links: unrecognized protocols are ignored, no link is generated.</span>  
<span lang="en" dir="ltr" class="mw-content-ltr">However, it's used in many other places too, including the code for [[Special:LinkSearch|Special:LinkSearch]], and utility functions like <code>wfParseUrl()</code> that are used in a wide variety of different places.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
These examples would not work (because <code>"test://"</code> is not defined as a valid protocol):
</div>

* test://www.example.com
* [test://www.example.com]
* [test://www.example.com <span lang="en" dir="ltr" class="mw-content-ltr">link text</span>]

{{Note|1={{unordered list
|1=<span lang="en" dir="ltr" class="mw-content-ltr">Some browsers, like Mozilla Firefox, will not follow file URLs on pages that have been loaded via HTTP.</span> <span lang="en" dir="ltr" class="mw-content-ltr">This is a security measure.</span> <span lang="en" dir="ltr" class="mw-content-ltr">See [http://kb.mozillazine.org/Links_to_local_pages_don%27t_work this mozillaZine article] for more information, including some hints on how to overcome this restriction.</span>
|2=<span lang="en" dir="ltr" class="mw-content-ltr">Most browsers do not support "remote file" URLs like <code>file://host/share</code> (only Internet Explorer handles these per default.</span> 
<span lang="en" dir="ltr" class="mw-content-ltr">For Firefox, a plugin is required or use exactly 5 slashes like <code>file://///host/share</code>, see [http://kb.mozillazine.org/Links_to_local_pages_don%27t_work#UNC_Paths])</span>}}
}}
{{Warning|1=<span lang="en" dir="ltr" class="mw-content-ltr">In MediaWiki 1.20.2+, adding {{phpi|"file:"}} without trailing slashes to <code>$wgUrlProtocols</code> will break [[Special:MyLanguage/Help:Images#Rendering a single image|image embedding]] using the <code><nowiki>[[File:Image.jpg]]</nowiki></code> syntax.</span> 
<span lang="en" dir="ltr" class="mw-content-ltr">This is [[phabricator:T46011|a known bug]] related to a change that made URL protocol matching case-insensitive.  As a workaround, use <code>"file://"</code> instead of <code>"file:"</code> as shown below.</span>}}

<div lang="en" dir="ltr" class="mw-content-ltr">
To allow links to local files (which may make sense in an intranet context), put this into your {{ll|Manual:LocalSettings.php|LocalSettings.php}}:
</div>

<syntaxhighlight lang="php">
$wgUrlProtocols[] = "file://";
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
Usually you only want to add protocols to this array.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Default values ===
</div>

{{MW 1.38|+|gerrit change=876412}}
{{MW 1.35|gerrit change=876392}}
<syntaxhighlight lang="php">
$wgUrlProtocols = [
	'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
	'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'matrix:', 'mms://',
	'news:', 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:',
	'ssh://', 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:',
	'//',
];
</syntaxhighlight>

{{MW version|version=1.24|version2=1.37}}
<syntaxhighlight lang="php">
$wgUrlProtocols = [
	'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
	'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
	'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
	'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:','slack://', '//', 
];
</syntaxhighlight>

{{MW version|version=1.22|version2=1.23}}
<syntaxhighlight lang="php">
$wgUrlProtocols = array(
	'http://',
	'https://',
	'ftp://',
	'ftps://', // If we allow ftp:// we should allow the secure version.
	'ssh://',
	'sftp://', // SFTP > FTP
	'irc://',
	'ircs://', // @bug 28503
	'xmpp:', // Another open communication protocol
	'sip:',
	'sips:',
	'gopher://',
	'telnet://', // Well if we're going to support the above.. -ævar
	'nntp://', // @bug 3808 RFC 1738
	'worldwind://',
	'mailto:',
	'tel:', // If we can make emails linkable, why not phone numbers?
	'sms:', // Likewise this is standardized too
	'news:',
	'svn://',
	'git://',
	'mms://',
	'bitcoin:', // Even registerProtocolHandler whitelists this along with mailto:
	'magnet:', // No reason to reject torrents over magnet: when they're allowed over http://
	'urn:', // Allow URNs to be used in Microdata/RDFa <link ... href="urn:...">s
	'geo:', // urls define geo locations, they're useful in Microdata/RDFa and for coordinates
	'//', // for protocol-relative URLs
);
</syntaxhighlight>

{{MW version|version=1.18|version2=1.21}}
<syntaxhighlight lang="php">
$wgUrlProtocols = array(
	'http://',
	'https://',
	'ftp://',
	'irc://',
	'ircs://', // @bug 28503
	'gopher://',
	'telnet://', // Well if we're going to support the above.. -ævar
	'nntp://', // @bug 3808 RFC 1738
	'worldwind://',
	'mailto:',
	'news:',
	'svn://',
	'git://',
	'mms://',
	'//', // for protocol-relative URLs
);
</syntaxhighlight>

{{MW 1.17}}{{-}}
<syntaxhighlight lang="php">
$wgUrlProtocols = array(
	'http://',
	'https://',
	'ftp://',
	'irc://',
	'gopher://',
	'telnet://', // Well if we're going to support the above.. -ævar
	'nntp://', // @bug 3808 RFC 1738
	'worldwind://',
	'mailto:',
	'news:',
	'svn://',
	'git://',
	'mms://',
);
</syntaxhighlight>

{{MW version|version=1.15|version2=1.16}}{{-}}
<syntaxhighlight lang="php">
$wgUrlProtocols = array(
	'http://',
	'https://',
	'ftp://',
	'irc://',
	'gopher://',
	'telnet://', // Well if we're going to support the above.. -ævar
	'nntp://', // @bug 3808 RFC 1738
	'worldwind://',
	'mailto:',
	'news:',
	'svn://',
);
</syntaxhighlight>

{{MW version|version=1.6|version2=1.14}}{{-}}
<syntaxhighlight lang="php">
$wgUrlProtocols = array(
	'http://',
	'https://',
	'ftp://',
	'irc://',
	'gopher://',
	'telnet://', // Well if we're going to support the above.. -ævar
	'nntp://', // @bug 3808 RFC 1738
	'worldwind://',
	'mailto:',
	'news:'
);
</syntaxhighlight>

{{MW 1.5}}{{-}}
<syntaxhighlight lang="php">
$wgUrlProtocols = 'http:\/\/|https:\/\/|ftp:\/\/|irc:\/\/|gopher:\/\/|news:|mailto:';
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Advanced modification ===
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">The default protocols should all be safe to click on (no evil side effects), and removing a protocol from the list will cause URLs using those protocols to become unrecognized in many places throughout the software.</span>  
<span lang="en" dir="ltr" class="mw-content-ltr">In particular, removing 'http://' or other common protocols will probably break huge amounts of stuff.</span> 
<span lang="en" dir="ltr" class="mw-content-ltr">Nevertheless, if you need to do so (for example, you already have a News: namespace), you can do something like this:</span>

<syntaxhighlight lang="php">
$wgUrlProtocols = array_diff($wgUrlProtocols, array('news:'));
</syntaxhighlight>


<div lang="en" dir="ltr" class="mw-content-ltr">
== See also ==
</div>
* <span lang="en" dir="ltr" class="mw-content-ltr">[[m:Special:MyLanguage/URI schemes|URI schemes]] (historical)</span>
* {{ll|UNC links}}