Plugin / Allkeyshop Widget

Installation

How to use

Widget

You can find the Allkeyshop Widget in the Appearance > Widgets menu.

The configuration of the widget is pretty straight forward. You can find the details of the parameters in the shortcode section.

Shortcode

This plugin provides the allkeyshop_widget shortcode. It takes the following parameters :

argument | default | values | description
— | — | — | —
target | none (required) | Game ID or top click slug | The product you want to display.
You can find a game ID or a top click slug with the game finder.
width | auto | \”auto\” or a size in pixels | The width of the widget.
Values can be all CSS values for the width property.
width | auto | \”auto\” or a size in pixels | The height of the widget.
Values can be all CSS values for the height property.
locale | en_GB | en_GB, fr_FR, es_ES, de_DE, it_IT | The locale of the widget.
This may change the results, such as news.
currency | eur | eur, usd | The currency of the prices.
Some offers might be available for a currency and not for the other.
The behaviour of this parameter is prone to change.
tabs | all tabs visible | A combination of tab names separated by a comma | The tabs that will appear on the widget.
Click here to see the available tabs.
default_tab | offers | Tab name | The tab that will be shown by default.
custom_page_title | none | String | The name of the custom page tab.
custom_page_url | none | URL | The URL of the custom page tab.

This plugin also provides a shortcode generator, so you don\’t have to write all the tedious stuff. You can find it in the Allkeyshop Widget > Shortcode Generator menu.

Tabs

tab name | description
— | —
gameName | Shows the name of the current game. This tab has no content (i.e. you can\’t click on it).
offers | Lists the best prices for the current game.
reviews | Shows all ratings from different websites.
history | Shows a graph representing the evolution of the prices.
similarGames | Lists similar games.
customPage | Embed the page of your choice inside the widget.
For example, it can be use to show a custom description of the game.
A \”gameId\” GET variable will be appened to the URL so you render the right content according to this.
priceAlert | The form to create user alerts for when the prices goes below a certain value.

Finding a game ID or a top click list slug

To find the ID of a game, you can use the tool in the Allkeyshop Widget > Game Finder menu.

This tool also lists all the top clicks available, along with their slugs.