Live Demo: Try this and other plugins live — no installation, no risk: demo.markus-michalski.net
src/
├── MmdFacebookPixel.php # Plugin class: activation, uninstall
├── Capi/ # CAPI client, connection test, PiiHasher, server context
├── Configuration/ # FacebookPixelConfig and factory (reads the system config)
├── Controller/Admin/ # TestConnectionController
├── Event/ # PixelEvent and the six event classes, PixelEventDispatched
├── MessageQueue/ # SendCapiEventMessage and handler
├── Migration/ # Create the Klaro service
├── Renderer/ # PixelJsRenderer (creates the fbq calls)
├── Service/ # ConsentChecker, EventDataExtractor, PixelCodeRenderer, KlaroServiceInstaller
├── Struct/ # FacebookPixelStruct (page extension fbPixelEvent)
├── Subscriber/ # Page subscribers and CapiEventListener
└── Resources/ # config.xml, routes, services, snippets, template, admin component
| Class | Listens to | Task |
|---|---|---|
StorefrontRenderSubscriber |
StorefrontRenderEvent |
Passes base code and PageView to the template, reports PageView for the CAPI |
ProductPageSubscriber |
ProductPageLoadedEvent |
ViewContent |
CategoryPageSubscriber |
NavigationPageLoadedEvent |
ViewCategory (loads the category via navigationId) |
CheckoutSubscriber |
CheckoutCartPageLoadedEvent, CheckoutConfirmPageLoadedEvent |
AddToCart (cart page), InitiateCheckout (confirmation page) |
OrderCompletedSubscriber |
CheckoutFinishPageLoadedEvent |
Purchase |
CapiEventListener |
PixelEventDispatched |
Checks the CAPI conditions, hashes email and phone, puts the message into the queue |
The page subscribers attach the tracking script to the page as the page extension fbPixelEvent. The template storefront/base.html.twig extends @Storefront/storefront/base.html.twig and outputs base code, PageView and the event script in the block base_body_script.
PixelEventDispatched is a regular Symfony event. Anyone who dispatches it with a PixelEvent and a ServerEventContext sends an event through the same CAPI conditions as the built-in ones.PixelEventRendererInterface and ConversionsApiClientInterface are registered as interfaces. PixelJsRenderer and ConversionsApiClient sit behind them.The classes are final. Create custom events by deriving your own class from PixelEvent rather than extending the existing ones.
| Property | Value |
|---|---|
| Method and path | POST /api/_action/mmd-facebook-pixel/test-connection |
| Route name | api.action.mmd_facebook_pixel.test_connection |
| Permission | system_config:read |
| Body (JSON) | pixelId, accessToken, optional testEventCode |
| Response (JSON) | success, httpStatus, messageKey, metaErrorMessage, metaErrorCode |
messageKey is one of success, missingPixelId, missingToken, invalidPixelId, metaError, networkError. The matching texts are in the admin snippets, see Configuration.
| When | Action |
|---|---|
| Install/update (migration) | Creates the Klaro service facebook-pixel if MmdKlaroConsent is installed |
| Activation | Creates the Klaro service if it is still missing and the Klaro table exists |
| Uninstall without "keep data" | Removes the Klaro service with its translations and all MmdFacebookPixel.config.* entries from system_config |
<, >, & and quotes, and it must consist of digits only.AsyncMessageInterface and therefore run through the asynchronous transport.