README

Use Plausible Analytics to track visitors and events in your Sylius store.

Installation

Step 1: Install and enable the plugin

composer require setono/sylius-plausible-plugin

Step 2: Add the Plausible script identifier trait to your Channel entity

<?php

declare(strict_types=1);

namespace App\Entity\Channel;

use Doctrine\ORM\Mapping as ORM;
use Setono\SyliusPlausiblePlugin\Model\ChannelInterface as PlausibleChannelInterface;
use Setono\SyliusPlausiblePlugin\Model\ChannelPlausibleAwareTrait;
use Sylius\Component\Core\Model\Channel as BaseChannel;

#[ORM\Entity]
#[ORM\Table(name: 'sylius_channel')]
class Channel extends BaseChannel implements PlausibleChannelInterface
{
    use ChannelPlausibleAwareTrait;
}

Step 3: Update your database schema

bin/console doctrine:migrations:diff
bin/console doctrine:migrations:migrate

Usage

Configure Plausible per channel

Navigate to Marketing > Plausible in the admin panel to configure the Plausible script for each channel.

You can enter the Plausible script in any of the following formats:

Identifier only: pa-hb0WlWkUb5U3qhSS-vd-a
Full URL: https://plausible.io/js/pa-hb0WlWkUb5U3qhSS-vd-a.js
HTML snippet: <script async src="https://plausible.io/js/pa-hb0WlWkUb5U3qhSS-vd-a.js"></script>

The plugin will normalize any of these formats and output the correct script tag on your storefront.

setono / sylius-plausible-plugin

Maintainers

Details