Skip to content


Subversion checkout URL

You can clone with
Download ZIP


Developer doc: build very simple example plugins #5700

mattab opened this Issue · 9 comments

5 participants


It’s hard to write a good developer documentation. Examples are easier to understand and to maintain. We will write a number of plugins, that each uses one feature of Piwik:

  • ExampleDBAccess
  • ExampleFeedburner
  • ExampleWidget
  • ExampleEditMenu
  • Other features to cover in example plugins: API, plotting data, recording new data in new db table, running tests, using a config file, using the “option” mechanism, etc.

Then we would:

  • build a wiki page listing all the Example plugins
  • print their quick description
  • link to their source code

Examples of other open source project plugin documentation

  • writing a plugin
  • plugin api
  • mediawiki plugin hooks

Ideas of simple useful plugins

  • “You have X websites and Y users registered in Piwik. You are using Piwik A.B version.”
  • “Featured user” that randomly picks a use case from our use case base.
  • “Piwik has been downloaded N times.”

Technical notes:

  • content loaded from via highly cached proxy pages
  • if is down, should not affect loading time of dashboard
  • have one widget for general purpose content (Piwik has been downloaded X times)

I added two new widgets in changeset 2958

  • "You have X websites and Y users registered in Piwik. You are using Piwik A.B version."
  • "Piwik has been downloaded N times."

They demonstrate simple database queries and a remote API call to (via jquery ajax request). Both widgets use templates.


greg: You forgot to check in the en.php - both widgets appear but their translations are missing.


We should also have the documentation point to ExampleUI plugin


It would be nice to document how plugins can create new sections in the config file.

Something like this (but finding a way not to call the __destruct would be better)

$config = Zend_Registry::get('config');
$config->MobileAnalytics = array("TeraWurflURL"=>"unconfigured");

I'm not sure why it wasn't working before, but this works great now.

TeraWurflURL = "unconfigured"


Agree. Planning a cleaner config writer should already be in #1713.


Also, while writing dev doc, I recommend going through the config.ini.php settings to find out which ones could be of interest to the Piwik plugin developer (I'm thinking eg. disable_merged_assets, track_visits_inside_piwik_ui, always_archive_* etc.)


The new general layout of the documentation is now in place (

Plugin guides are part of the new organization but are yet to be written. The proposed list is :

Development Guides

Basic architecture
Adding a widget
Use Smarty templates
Accessing the database
Editing the menu
Using Piwik's API
Plotting Data
Recording new Data
Adding options in config.ini


Should include guide :
Internationalization and localization
See forum post


Mostly we have such simple plugins now. The docs are still missing but will be covered in separate plugin. For latest docs on plugin development see:

@mattab mattab added this to the Community and Marketing milestone
@JulienMoumne JulienMoumne was assigned by mattab
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.