Extension:HeaderExtension

MediaWiki extensions manual
OOjs UI icon advanced-invert.svg
HeaderExtension
Release status: stable
Implementation Hook , MyWiki
Description Adds Scripts and Meta data just before the </head> tag of the wiki
Author(s)
Latest version 2.0.0 (2021-01-10)
MediaWiki 1.23+
PHP 5.4+
Database changes No
License MIT License
Download

  • $wgHeadMetaName
  • $wgHeadMetaCode
  • $wgHeadScriptName
  • $wgHeadScriptCode

Check usage and version matrix.

The HeaderExtension extension allows Scripts and Meta data to easily be added just before the </head> tag of the wiki.

The code for the head Scripts and Meta date are defined in "LocalSettings.php " and is controlled by variables. This implementation makes it easy for inexperienced users to implement head Scripts and Meta date just before the </head> tag of the wiki. It also makes it possible to add head Scripts and Meta date that cannot be changed or removed, such as would be possible by wiki Administrators if the head Scripts and Meta date were added to the Sitenotice . This makes the extension particularly useful for placing Cookie Consent plugin or CSS style links, as such content cannot be removed by abusive or rogue administrators.

InstallationEdit

  • Download and place the file(s) in a directory called HeaderExtension in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'HeaderExtension' );
    
  • Configure as required.
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.23 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension(). If you need to install this extension on these earlier versions (MediaWiki 1.23 and earlier), instead of wfLoadExtension( 'HeaderExtension' );, you need to use:

require_once "$IP/extensions/HeaderExtension/HeaderExtension.php";

ConfigurationEdit

One or more head scripts can be added to the wiki. The head scripts can consist of any HTML and/or JavaScript.

ScriptsEdit

SchemeEdit

To configure the head script, add the following to "LocalSettings.php" after the installation line:

$wgHeadScriptCode = <<<'START_END_MARKER'
<script></script>
START_END_MARKER;

Leave untouched the first and last line with START_END_MARKER stuff, this is a special syntax of PHP (without it, it would be tricky to deal with apostrophes inside the script). Do not add whitespaces around the last line’s marker, it would break it (more details about this syntax). Do add new line after.

To add additional scripts, simply include them between the markers:

$wgHeadScriptCode = <<<'START_END_MARKER'
<script></script>
<script></script>
<script></script>
START_END_MARKER;

You may specify a name for the script too if needed, add the following after the installation line:

$wgHeadScriptName = 'add_your_script_name_here';

ExamplesEdit

Example (from Extension:Google Analytics Integration):

$wgHeadScriptCode = <<<'START_END_MARKER'
<script>
  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
  ga('create', 'UA-xxxxxxxx-xx', 'auto');
  ga('set', 'anonymizeIp', true);
  ga('send', 'pageview');
</script>
START_END_MARKER;
$wgHeadScriptName = 'googleanalytics';

Meta dataEdit

SchemeEdit

To configure the head meta data, add the following to "LocalSettings.php" after the installation line:

$wgHeadMetaName = 'add_your_meta_data_name_here';
$wgHeadMetaCode = 'add_your_meta_data_code_here';

ExamplesEdit

Example (from Extension:AgeClassification):

$wgHeadMetaName = 'age-de-meta-label';
$wgHeadMetaCode = 'age=0 hash: yourdigitalcode v=1.0 kind=sl protocol=all';

See alsoEdit

The extension HeaderExtension combines functionality from