Skip to content

[00] Subset Opt-Out, User guide

PixelYourSite

Last updated

How Subset Opt-Out holds PixelYourSite's pixels for visitors who opt out, what happens to its server-side events, and the limits.

Subset Opt-Out holds PixelYourSite’s tracking for visitors who opt out, with no setup. While PixelYourSite is active, a PixelYourSite service appears under 1. Services on Subset → Opt-Out, switched on. Opted-out visitors don’t run its pixels, and Subset Opt-Out tells PixelYourSite not to send their server-side events.

What works

  • The pixel bundle is held. PixelYourSite loads every pixel it manages from one script, with its settings in an inline pysOptions block. Subset Opt-Out holds both, matched by script handle and by URL, so they don’t run for a visitor who has opted out.
  • Its cookies are cleared on opt-out. When a visitor opts out during a visit, Subset Opt-Out deletes PixelYourSite’s cookies (pys_*, last_pys_*, pysTrafficSource, last_pysTrafficSource and pbid) and Meta’s _fbp and _fbc.
  • Server-side events follow the choice. Subset Opt-Out hooks PixelYourSite’s pys_check_consent_by_gdpr filter, which PixelYourSite checks per pixel before it reports an event from the server, and answers it from the visitor’s saved choice, with Global Privacy Control applied the same way as in the browser. Meta, Pinterest, Bing, Reddit, OpenAI and Google Ads follow the marketing category. Google Analytics and Tag Manager follow statistics.
  • The settings screen and Site Health report it. Under 1. Services, the Integrations detected note says whether PixelYourSite’s pixel is held. Tools → Site Health shows a warning if it isn’t.

What needs a setting

Leave the PixelYourSite service switched on under 1. Services. If it’s off, PixelYourSite runs for everyone and the Site Health test says so.

To stop Google Analytics and Tag Manager events from PixelYourSite’s server side as well, turn on Opt-out also covers analytics under 5. What an opt-out covers. It’s off by default, so an opt-out stops advertising only.

Known limits

  • The whole bundle follows marketing. PixelYourSite loads Google Analytics and Tag Manager from the same script as its ad pixels, and one script can’t be split. In the browser, an opted-out visitor’s Google Analytics events from PixelYourSite stop too, even with Opt-out also covers analytics off.
  • Server-side events only follow the choice on uncached pages. A page served from a page cache never reaches PHP, so no server-side event is sent for it at all. The browser side of a cached page follows the choice as usual.
  • Detection looks for two markers. The service is added when the PYS_FREE_VERSION constant or the PixelYourSite\PYS function exists. If your copy of PixelYourSite defines neither, add a custom rule for its script, or ask a developer to return true from the subset_cm_pixel_plugin_active filter for pixelyoursite.