Disable send all pixels events, can by used for custom gdpr
Param: bool $status
add_filter('pys_disable_by_gdpr',function ($status) {
if(get_current_user_id() == 0 ) {
return true;
}
return $status;
});
{pixel} - facebook, ga, gtm, pinterest, bing, reddit, openai
The Google pixels share one name: pys_disable_analytics_by_gdpr stops GA and GTM everywhere, while pys_disable_ga_by_gdpr and pys_disable_gtm_by_gdpr reach only the no-script tags.
Disable some pixel events, can by used for custom gdpr
Param: bool $status
add_filter('pys_disable_facebook_by_gdpr',function ($status) {
if(get_current_user_id() == 0 ) {
return true;
}
return $status;
});
Load latest gdpr pixel status before load web pixel. Can by used when server use page caching
Param: bool $status
add_filter('pys_gdpr_ajax_enabled',function ($status) {
if(get_current_user_id() == 0 ) {
return true;
}
return $status;
});
Allows developers to programmatically override consent status for GDPR compliance. Receives the current consent value, allowing you to customize logic to determine whether consent should be enabled or disabled. Useful for integrating with third-party consent management solutions or custom privacy workflows.
Param: bool $status
add_filter('pys_check_consent_by_gdpr',function ($status) {
if(get_current_user_id() == 0 ) {
return true;
}
return $status;
});
{mode name} - analytics_storage, ad_storage, ad_user_data, ad_personalization
Param: bool $mod
add_filter('pys_analytics_storage_mode',function ($mode) {
if(get_current_user_id() == 0) {
return true;
}
return $mode;
});
Fire the pixel with consent mode "analytics_storage": "granted"
Param: bool $mode
add_filter('pys_bing_ad_storage_mode',function ($mode) {
if(get_current_user_id() == 0) {
return true;
}
return $mode;
});
Fire the Bing with consent mode "ad_storage": "granted"
Param: bool $status
add_filter('pys_url_passthrough_mode',function ($status) {
if(get_current_user_id() == 0) {
return true;
}
return $status;
});
Param: bool $status
add_filter('pys_meta_ldu_mode',function ($status) {
if(get_current_user_id() == 0) {
return true;
}
return $status;
});
Param: bool $status
add_filter('pys_reddit_ldu_mode',function ($status) {
if(get_current_user_id() == 0) {
return true;
}
return $status;
});
Param: bool $status
When it returns true, every OpenAI event is sent with opt_out: true — in OpenAI's words, the event is opted out of future user-level personalization. The conversion is still measured, so this is the counterpart of Meta Limited Data Use, not a way to stop tracking: to stop it, do not give the pixel consent at all.
Both copies of the event follow this filter — the browser Pixel and the Conversions API — so a deduplicated pair cannot disagree.
add_filter('pys_openai_consent_mode',function ($status) {
if(get_current_user_id() == 0) {
return true;
}
return $status;
});
disable all PYS cookies
Param: bool $status
add_filter('pys_disable_all_cookie',function ($status) {
$user = wp_get_current_user();
$roles = ( array ) $user->roles;
if(in_array('administrator', $roles) ) {
return true;
}
return $status;
});
there are also filters to disable certain groups of cookies that work on the same principle
pys_disabled_start_session_cookie - disable start_session & session_limit cookie
pys_disable_first_visit_cookie - disable pys_first_visit cookie
pys_disable_landing_page_cookie - disable pys_landing_page & last_pys_landing_page cookies
pys_disable_trafficsource_cookie - disable pysTrafficSource & last_pysTrafficSource cookies
pys_disable_utmTerms_cookie - disable ['utm_source', 'utm_medium', 'utm_campaign', 'utm_content' ,'utm_term'] with prefix pys_ and last_pys_ cookies
pys_disable_utmId_cookie - disable ['fbadid', 'gadid', 'padid', 'bingid'] with prefix pys_ and last_pys_ cookies
pys_disable_advance_data_cookie - disable pys_advanced_data cookies
pys_disable_externalID_by_gdpr - disable pbid(external_id) cookie
Param: string $domain, string $host
PYS normally learns the cookie domain from the visitor's browser: the front-end script reports which domain the browser actually accepted, and server-side _fbp waits for that answer. Return a domain here to skip the handshake — for sites where the script cannot run (aggressive page caching, a consent tool blocking it) or for unusual multi-domain setups.
The value must cover the current host (e.g. .example.com for shop.example.com), otherwise it is ignored. Return an empty string to let PYS decide. Register the filter no later than init priority 20 — plugins_loaded is the safe place.
add_filter( 'pys_cookie_domain_override', function ( $domain, $host ) {
return '.example.com';
}, 10, 2 );
Param: int $days
90 days by default — the same lifetime Meta's own pixel gives _fbp. This is deliberately separate from the «First Visit» cookie duration setting, which controls the attribution cookies (landing page, traffic source, UTMs) and not the advertising identifiers.
The value is clamped between 1 and 400 days: browsers refuse to keep a cookie longer than 400 days, so a larger number would only pretend.
add_filter( 'pys_fb_cookie_lifetime_days', function ( $days ) {
return 30;
} );
{platform} - openai, or pinterest (needs the PixelYourSite Pinterest add-on); the TikTok variant exists in PixelYourSite PRO
Param: int $days
PYS stores each platform's ad click id in a first-party cookie (pys_ttclid, pys_epik, __oppref) so a purchase sent later — from the events queue, a payment webhook, an admin order-status change — still carries the click that brought the buyer.
Defaults: TikTok 90 days (TikTok asks integrators to store the click id for 28 days or more), Pinterest 365 days (matching Pinterest's own _epik cookie), OpenAI 90 days. Values are clamped between 1 and 400 days.
add_filter( 'pys_pinterest_cookie_lifetime_days', function ( $days ) {
return 30;
} );
Param: bool $enabled
PYS bundles Meta's capi-param-builder library, switched off by default: everything it adds — millisecond creation time, the computed subdomain index, click-id recovery from the referrer — is already done by PYS itself, and PYS keeps its own IP detection and browser-verified cookie domain, which are stronger than the library's.
Turn it on to let the library produce the _fbp / _fbc values instead. It still runs behind the PYS consent checks and the cookie-domain handshake.
add_filter( 'pys_use_capi_param_builder', '__return_true' );
Params: string $value, int $user_id
When a visitor is logged in, their WordPress user ID travels alongside the browser ID as a second external ID, so the same person is recognised across devices and browsers. This filter receives the ID before it is hashed; whatever you return is SHA-256 hashed unless it already is a hash, which is the only format the browser Pixel and the Conversions API send identically.
Namespace it here if one Pixel serves several sites, where account 5 is a different person on each of them. Whatever you return must stay the same over time — changing it later starts a new identity and discards the matching built up so far.
add_filter('pys_external_id_user_value',function ($value, $user_id) {
return 'shop-' . $user_id;
}, 10, 2);
Params: array $ids, int $user_id
Meta's Conversions API takes external_id as one value or a list of them, and Pinterest's API takes a list; this is that list. It holds the browser ID first, then the ID stored for a logged-in visitor, then the hashed account ID. Return an empty array to send none.
Keep the browser ID in the set. The Pixel sends a single value, and matching only holds together while that value is one of the ones the server sends. Anything you add here is sent as you return it, so hash it yourself — the values already in the list are hashes.
add_filter('pys_external_ids',function ($ids, $user_id) {
$crm = $user_id ? get_user_meta($user_id, 'crm_contact_id', true) : '';
if ($crm) {
$ids[] = hash('sha256', strtolower(trim($crm)));
}
return array_values(array_unique(array_filter($ids)));
}, 10, 2);
Param: bool $isActive,string $pixelSlug
Return: Array
add_filter('pys_pixel_disabled',function ($isActive,$pixelSlug) {
if(get_current_user_id() == 0 && $pixelSlug == 'facebook') {
return ['all']; // Disable all pixels
}
return $isActive;
},11,2);
add_filter('pys_pixel_disabled',function ($isActive,$pixelSlug) {
if(get_current_user_id() == 0 && $pixelSlug == 'facebook') {
return ['1123450378576095', '1300447800692613']; // Disables pixels that are in the array
}
return $isActive;
},11,2);
{pixel} - facebook, ga, gtm, openai
Param: array $ids
add_filter('pys_facebook_ids',function ($ids) {
if(get_current_user_id() == 0) {
$ids[]='CUSTOM_PIXEL_ID';
}
return $ids;
});
You can disable some events depend on your logic
Param: bool $isActive, \PixelYourSite\PYSEvent $event, \PixelYourSite\Settings $pixel
add_filter('pys_validate_pixel_event',function ($isActive,$event,$pixel) {
if($pixel->getSlug() == "facebook"
&& $event->getId() == "woo_purchase"
&& get_current_user_id() == 0
) {
return false;
}
return $isActive;
},10,3);
Param: bool $status
add_filter('pys_disable_server_event_filter',function ($status) {
if(get_current_user_id() == 0 ) {
return true;
}
return $status;
});
Param: array $data, string $slug ,any $context
add_filter('pys_event_data',function ($data,$slug,$context) {
if(get_current_user_id() == 0 ) {
$data['params']['total'] = 0;
}
return $data;
},10,3);
Param: array $currencies
add_filter('pys_currencies_list',function ($currencies) {
$currencies['PTH'] = 'Test';
return $currencies;
});
Param: array $params
add_filter('pys_fb_advanced_matching',function ($params) {
if(get_current_user_id() == 0) {
$params['fn'] = "not_registered";
$params['ln'] = "not_registered";
}
return $params;
});
Param: \PYS_PRO_GLOBAL\FacebookAds\Object\ServerSide\UserData $userData
add_filter('pys_fb_server_user_data',function ($userData) {
if(get_current_user_id() == 0) {
$userData->setFirstName("undefined");
$userData->setLastName("undefined");
$userData->setEmail("undefined");
}
return $userData;
});
Param: FacebookAds\Object\ServerSide\Event $event,string $pixel_Id, string $eventId
add_filter('pys_before_send_fb_server_event',function ($event,$pixel_Id,$eventId) {
if(get_current_user_id() == 0 ) {
$event->setActionSource("not_registered");
}
return $event;
},10,3);
Param: bool $status
add_filter('pys_send_meta_id',function ($status) {
if(get_current_user_id() == 1) {
return false;
}
return $status;
});
Used by the JavaScript Pixel and the Conversions API alike, so a change here reaches both channels.
OpenAI accepts only these keys: email_sha256, phone_number_sha256, external_id_sha256, first_name_sha256, last_name_sha256, country, city, region, postal_code. Anything else is dropped before it is sent.
One value per key here — that is what the browser Pixel takes. The Conversions API accepts several per field; to reach those, filter pys_openai_matching_values instead.
Param: array $params
add_filter('pys_openai_advanced_matching',function ($params) {
if(get_current_user_id() == 0) {
unset($params['email_sha256']);
}
return $params;
});
The same identity as pys_openai_advanced_matching, but before it is reduced to one value per field: each key holds an ORDERED list. The Conversions API takes up to three emails and two phone numbers, and uses them in the order given — the browser Pixel takes only the first of each.
Keys are the same nine; values are arrays of already-normalised, already-hashed strings. Filter this to add a value the plugin cannot know about, or to reorder them; filter pys_openai_advanced_matching to change what the browser sends.
Params: array $values, int|null $wooOrder, int|null $eddOrder
add_filter('pys_openai_matching_values',function ($values) {
// A second address for the same customer, tried after the first.
$values['email_sha256'][] = hash('sha256', 'billing@example.com');
return $values;
});
Server events only. Fields: obref, email_sha256, external_id_sha256, country, city, zip_code, ip_address, user_agent.
Hashes must be lowercase 64-character hex. Geo, IP and user agent travel raw; raw emails, raw external ids and phone numbers in any form are rejected by OpenAI.
Params: object $userData, int|null $wooOrder, int|null $eddOrder
add_filter('pys_openai_server_user_data',function ($userData, $wooOrder, $eddOrder) {
if(get_current_user_id() == 0) {
unset($userData->email_sha256);
}
return $userData;
}, 10, 3);
OpenAI takes every amount as an integer number of minor units, so 10.00 USD travels as 1000. The exponent comes from the currency itself (ISO 4217): 0 for JPY, KRW and the other zero-decimal currencies, 3 for BHD, KWD and the rest of the three-decimal ones, 2 for everything else.
Deliberately not taken from the shop's price-decimals setting, which is a display preference. Use this filter only for a currency the list does not cover - returning the wrong exponent multiplies or divides every reported value by ten.
Params: int $exponent, string $currency
add_filter('pys_openai_currency_exponent',function ($exponent, $currency) {
if($currency == 'XYZ') {
return 0;
}
return $exponent;
}, 10, 2);
pys_edd_checkout_order_id - Edd plugin
pys_woo_checkout_order_id - WooCommerce plugin
Can by user for custom checkout page
Param: int $order_id
add_filter('pys_woo_checkout_order_id',function ($order_id) {
if(isset($_GET['custom_order_param_with_id'])) {
return $_GET['custom_order_param_with_id'];
}
return $order_id;
});
The WooCommerce Purchase event needs to know the order is really the visitor's own. It normally does, because the thank-you page carries the order key, the buyer is logged in, or the order was placed in the same session.
A few payment gateways return the buyer without the order key and with a cross-site POST, which drops the session cookie — for those, enable this filter. It only covers orders created within the last hour that were actually paid, and it never exposes customer personal data (email, phone, name, address).
Leave it off unless your Purchase event stopped firing after a gateway redirect.
add_filter( 'pys_woo_legacy_gateway_compat', '__return_true' );
// optional: widen the window (seconds, default 1 hour)
add_filter( 'pys_woo_legacy_gateway_compat_window', function () {
return 2 * HOUR_IN_SECONDS;
} );
Final say over whether the current request may read a WooCommerce order for tracking purposes. Use it to support an unusual gateway, or to tighten access further.
Params: bool $allowed, int $order_id, string $context ('default' for tracking payloads, 'pii' for personal data such as Advanced Matching)
add_filter( 'pys_woo_request_can_access_order', function ( $allowed, $order_id, $context ) {
// your gateway returns ?my_gateway_ref=<order id>&my_gateway_token=<token>
if ( ! $allowed && 'pii' !== $context && isset( $_GET['my_gateway_token'] ) ) {
return my_gateway_token_is_valid( $order_id, $_GET['my_gateway_token'] );
}
return $allowed;
}, 10, 3 );