Skip to content

mnapoli/MatomoTwigExtension

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Matomo Twig integration

Build Status

This library integrates Matomo into Twig. Previously named PiwikTwigExtension.

Installation

composer require "mnapoli/piwik-twig-extension"

Usage

You have 2 ways to give the Matomo host and site ID:

  • When creating the extension (recommended)

    $twig->addExtension(new MatomoTwigExtension('my-matomo-host.com', 123));

    In the templates, you then just call {{ matomo() }}.

    This solution is appropriate in most cases.

  • When calling the Twig function

    $twig->addExtension(new MatomoTwigExtension());

    In the templates, you have to provide the host and site id: {{ matomo('my-matomo-host.com', 123) }}.

    This solution is perfect if you want to be able to customize the site id or Matomo host in the template.


Don't forget to add the tracker script at the end of the HTML document, for example:

<!DOCTYPE html>
<html>
    <head>
        ...
    </head>
    <body>
        ...

        {{ matomo() }}
    </body>
</html>

Development environment

In some environments, you want to disable Matomo's tracking (for example on your local machine). That is easily possible by passing false for the $enabled parameter:

$twig->addExtension(new MatomoTwigExtension($host, $siteId, false));

License

This library is released under the MIT license.

About

Twig extension to provide Piwik integration

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages