API Reference

Hooks

Matomo for WordPress - Hooks

Filters

  • matomo_tracking_code_script ($script, $idsite)

    Plugins can modify the JavaScript tracking code which is embedded into the website to track visitors.

  • matomo_tracking_code_noscript ($noscript, $idsite)

    Plugins can modify the noscript tracking code which is used when JavaScript is not enabled.

  • matomo_tracking_user_id ($user_id_to_track)

    Plugins can customise which User ID is tracked if the User ID feature is enabled in tracking settings. For example you can anonymise the userId, or you can choose to only track specific users, etc.

  • matomo_report_summary_filter_limit ($limit)

    Plugins can customise the default limit of how many rows are shown for each report within the Matomo Summary page.

  • matomo_report_summary_report_ids ($reports_to_show)

    Defines which reports are shown on the Matomo Summary page. Plugins can remove or add additional reports by modifying $reports_to_show. For example $reports_to_show[] = 'UserCountry_getRegion';

  • matomo_setting_tabs ( $setting_tabs, \WpMatomo\Settings $settings )

    Lets you remove or add a new tab to the Matomo Settings page. A tab needs to implement the WpMatomo\Admin\AdminSettingsInterface and add the tab like this: $settings_tabs[] = new MyTab();.

  • matomo_install_tables ( $table_names )

    This may be needed if your WordPress plugin implements a Matomo plugin which creates a database table and you have automated PHPUnit tests. Say your plugin tracks custom data into a log_weather table. Then you would add $table_names[] = 'log_weather'. This will make sure to uninstall the table wp_matomo_log_weather table when the Matomo plugin is being uninstalled.

  • matomo_systemreport_tables ( $tables )

    Let's plugin enrich or filter the Matmo system report. Each table is an array containing keys like title and rows. Each row contains array keys like name, value, comment, is_warning, and is_error.

Actions

  • matomo_tracking_settings_changed ( \WpMatomo\Settings $settings )

This action is triggered whenever Matomo settings have changed. You can use it to overwrite settings, get notified on setting changes, and more.

  • matomo_uninstall ( $should_remove_all_data )

This action is executed after Matomo was uninstalled. The parameter $should_remove_all_data defines whether Matomo was supposed to delete all data.

  • matomo_uninstall_blog ( $should_remove_all_data )

If WP MultiSites is used, this action is executed after a particular blog was uninstalled.

  • matomo_site_synced( int $idsite, int $blog_id )

This action is executed each time a specific site in Matomo was synced / updated.

  • matomo_ecommerce_init ( \PiwikTracker $tracker )

This action can be used to register support for additional ecommerce stores. The hook is triggered on plugin load if the user has ecommerce and tracking enabled. An instance of the Matomo Tracker is passed and can be used to track purchases etc server side if needed (eg during an ajax request).

Need additional hooks?

Let us know by creating an issue on our issue tracker