Release status: stable
|Description||Displays Google AdSense ads on skins|
|Latest version||0.4.5 (2017-02-26)|
|Translate the ShoutWiki Ads extension if it is available at translatewiki.net|
|Check usage and version matrix.|
ShoutWiki Ads extension displays Google AdSense ads on skins. Currently it supports Monobook, Vector, Nimbus, Quartz, Refreshed, Aurora, Dusk, Monaco and Truglass skins.
The extension will not display ads
- when ads are disabled ($wgAdConfig['enabled'] = false;)
- on the login page (Special:UserLogin)
- on namespaces where ads are not enabled
- for autoconfirmed users
- if the wiki is in a language that is not supported by Google AdSense
This extension is currently very ShoutWiki-specific.
The reason why this extension was written was that in the past, each skin (at ShoutWiki) that should have ads needed to implement its own ad loader, which was not very easy to maintain, as it meant lots and lots of code duplication. To solve the problem, we stashed all the ad-related code into one class, and we'd just hook on the different hooks in different skins to display the ads.
Of course, the Monobook skin didn't have the hooks we needed to use, so we had to create them.
All the functions in the ShoutWikiAds class are public and static, so it's very easy to use the class.
- Download and place the file(s) in a directory called
- Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'ShoutWikiAds' );
- Configure the
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
The extension has only one configuration variable,
$wgAdConfig. It should look something like this:
$wgAdConfig = [ 'enabled' => true, // enabled or not? :P 'adsense-client' => '', // provider number w/o the "pub-" part 'namespaces' => [ NS_MAIN, NS_TALK ], // array of enabled namespaces 'right-column' => true, // do we want a skyscraper ad column (Monobook)? 'toolbox-button' => true, // or a "button" ad below the toolbox (Monobook)? 'monaco-sidebar' => true, // 200x200 sidebar ad in the sidebar on Monaco skin 'monaco-leaderboard' => true, // leaderboard (728x90) ad in the footer on Monaco skin 'truglass-leaderboard' => true, // leaderboard ad for Truglass skin ];
enabled key is set to
false, the extension will do nothing.
adsense-client key should be set to your AdSense provider number (just the number, not the "pub-" part!).
toolbox-button options apply only to the Monobook skin.
monaco-leaderboard options apply only to the Monaco skin, while
truglass-leaderboard option applies only to the Truglass skin.