Extension:HeadScript

From mediawiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
HeadScript
Release status: stable
Implementation Hook
Description Adds scripts just before </head> of the wiki
Author(s)
Latest version 1.1.1 (2020-09-30)
Database changes No
License MIT License
Download

  • $wgHeadScriptName
  • $wgHeadScriptCode
Translate the HeadScript extension if it is available at translatewiki.net
Check usage and version matrix.

The HeadScript extension allows scripts to easily be added just before </head> of the wiki.

The code for the head script is defined in "LocalSettings.php" and is controlled by variables. This implementation makes it easy for inexperienced users to implement head scripts just before </head> of the wiki. It also makes it possible to add head scripts that cannot be changed or removed, such as would be possible by wiki administrators if the head script were added to the site notice. 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.

Installation[edit]

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

To users running MediaWiki 1.26 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.26 and earlier), instead of wfLoadExtension( 'HeadScript' );, you need to use:

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

Configuration[edit]

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

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 = 'my-wonderful-script';