Menu de la documentationHooks et filtres

Hooks et filtres

Les actions et filtres que Vireo Analytics et Vireo Pro proposent aux propriétaires de sites et aux développeurs, avec leurs arguments et leurs valeurs par défaut.

Sur cette page

Ajoutez-les dans le functions.php de votre thème ou dans un petit plugin. Les hooks qui servent uniquement à faire fonctionner ensemble le plugin gratuit et Pro ne sont pas listés.

Le point de terminaison rapide et les filtres

Vireo enregistre chaque vue via un petit point de terminaison qui charge WordPress sans vos plugins ni votre thème, ce qui le rend rapide. Si vous utilisez l’un de ces filtres, Vireo le détecte et enregistre les vues via la route standard admin-ajax.php, où votre code s’exécute :

vireo_trust_proxy_headers, vireo_beacon_rate_limit_per_minute, vireo_beacon_rate_limit_shard_keys, vireo_honor_opt_out, vireo_bot_ua_pattern, vireo_bot_signatures, vireo_geo_country_headers, vireo_buffer_dir_max_bytes, vireo_headless_allowed_origins, vireo_shorten_ip.

Hook Type Arguments Rôle
vireo_force_direct_endpoint filtre bool|null $force (null par défaut) false enregistre chaque vue via admin-ajax.php. true utilise le point de terminaison rapide sans le tester d’abord, pour les hébergeurs qui bloquent les requêtes d’un site vers lui-même. Les filtres ci-dessus, et une adresse de point de terminaison sur un autre hôte, utilisent toujours admin-ajax.php.
vireo_endpoint_url filtre string $url L’adresse à laquelle le tracker envoie les vues. Par défaut, le endpoint.php du plugin. Si elle pointe vers un autre hôte, par exemple parce qu’un CDN l’a réécrite, Vireo utilise admin-ajax.php à la place.

Vireo vérifie le point de terminaison à l’activation, puis toutes les heures : une modification de l’un de ces deux filtres prend donc effet à la vérification suivante.

Suivi

Hook Type Arguments Rôle
vireo_load_tracking_script filtre bool $load (true par défaut) Renvoyez false pour garder le tracker hors de la page courante.
vireo_print_tracking_script action aucun Appelez-la avec do_action() avant </body> dans un template sans wp_footer(). Elle affiche le tracker une seule fois.
vireo_honor_opt_out filtre bool $honor (true par défaut) Renvoyez false pour compter les visiteurs qui envoient Do Not Track ou Global Privacy Control.
vireo_require_consent filtre bool $require (false par défaut) Renvoyez true pour attendre le consentement aux statistiques d’un plugin WP Consent API.
vireo_collect_web_vitals filtre bool $collect (true par défaut) Renvoyez false pour arrêter de collecter les Core Web Vitals.
vireo_auto_event_download_exts filtre string $exts, extensions séparées par | Les types de fichiers qu’enregistre l’événement automatique Téléchargements de fichiers. Par défaut pdf|zip|rar|7z|doc|docx|xls|xlsx|ppt|pptx|csv|mp3|mp4|mov|wav|dmg|pkg|exe|apk.
vireo_track_form_success filtre bool $track (true par défaut) Renvoyez false pour arrêter d’enregistrer les événements form_success des plugins de formulaires.
vireo_form_success action string $value, string $id, string $title Se déclenche quand un plugin de formulaire accepte un envoi que Vireo compte. $value est la valeur de l’événement, $id l’identifiant du formulaire pour le plugin de formulaire et $title le titre du formulaire.
vireo_amp_has_consent filtre bool $has (false par défaut) Sur les pages AMP, tant que le consentement aux statistiques est requis, le tracker ne s’affiche que si ce filtre renvoie true. Une intégration de consentement qui affiche son invite dans la sortie AMP le définit.
vireo_shorten_ip filtre bool $shorten Active ou désactive le raccourcissement des IP quel que soit le réglage « Raccourcir les adresses IP ». Part de ce réglage.
vireo_track_wpra filtre bool $track (true par défaut) Renvoyez false pour arrêter de compter les clics sur les éléments de WP RSS Aggregator.
vireo_track_spotlight filtre bool $track (true par défaut) Renvoyez false pour arrêter de compter les clics sur les flux Spotlight.
vireo_show_admin_bar filtre bool $show, int $user_id Détermine si la barre d’outils affiche les pages vues du jour pour cet utilisateur. Part du réglage Barre d’outils.
// Keep the tracker off a landing page used for ad tests.
add_filter( 'vireo_load_tracking_script', function ( $load ) {
	return is_page( 'ad-test' ) ? false : $load;
} );

Robots et comptage

Hook Type Arguments Rôle
vireo_bot_ua_pattern filtre string $pattern, une expression régulière sans délimiteurs Remplace tout le motif des robots. Les correspondances sont rapportées comme Autres robots.
vireo_bot_signatures filtre array $signatures, catégorie vers expression régulière combinée La liste étendue de robots, générée à partir de Matomo Device Detector. Renvoyez un tableau vide pour l’ignorer et ne garder que la liste propre à Vireo.
vireo_visitor_path_cap filtre int $cap (5 par défaut) Nombre maximal de vues d’une même page qu’un visiteur peut ajouter en une journée.
vireo_visitor_daily_cap filtre int $cap (50 par défaut) Nombre maximal de vues qu’un visiteur peut ajouter en une journée.
vireo_beacon_rate_limit_per_minute filtre int $limit (60 par défaut) Pages vues acceptées par minute depuis une même adresse. 0 ou moins désactive la limite.
vireo_beacon_rate_limit_shard_keys filtre int $keys (2000 par défaut) Combien d’adresses chaque fichier de limitation de débit mémorise avant d’abandonner les plus anciennes. 0 ou moins les garde toutes. Voir le point de terminaison rapide.
vireo_is_datacenter_hit filtre bool $is_datacenter, string $ip, string $path, string $ua Détermine si une première visite sans référent compte comme du trafic de réseau d’hébergement. Part des plages d’hébergement fournies avec le plugin. Utilisé uniquement quand Réseaux d’hébergement est activé sous Réglages > Suivi > Géolocalisation.
vireo_referrer_spam_hosts filtre string[] $hosts Hôtes traités comme du spam de référents, en plus de la liste fournie et de ceux que vous avez bloqués. Domaines en minuscules ; les sous-domaines correspondent aussi.
vireo_own_hosts filtre array $hosts, URL ou hôtes Hôtes jamais comptés comme référents parce qu’ils sont ce site. Part des adresses du site et du front-end découplé.
vireo_ai_sources filtre array $map, libellé vers expression régulière d’hôte Les assistants IA reconnus comme référents.
// Recognise another assistant as an AI referrer.
add_filter( 'vireo_ai_sources', function ( $map ) {
	$map['Example AI'] = '(^|\.)example-ai\.com$';
	return $map;
} );

Proxys et adresses

Hook Type Arguments Rôle
vireo_trust_proxy_headers filtre bool $trust (false par défaut) Renvoyez true pour lire l’adresse du visiteur dans CF-Connecting-IP, X-Forwarded-For ou X-Real-IP quand la requête vient d’un proxy de confiance.
vireo_trusted_proxies filtre array $cidrs Réseaux dont les en-têtes de transfert sont crus. Par défaut, le bouclage local, les plages privées et Cloudflare.
vireo_geo_country_headers filtre array $headers Clés $_SERVER lues pour un code pays fourni par votre hébergeur ou votre CDN, comme HTTP_CF_IPCOUNTRY.
add_filter( 'vireo_trust_proxy_headers', '__return_true' );
add_filter( 'vireo_trusted_proxies', function ( $cidrs ) {
	$cidrs[] = '203.0.113.0/24'; // Your load balancer.
	return $cidrs;
} );

Front-ends découplés et sites connectés

Hook Type Arguments Rôle
vireo_headless_post_id filtre int $post_id, string $path, string $site, int $claimed Associe un chemin du front-end à un article quand la correspondance par chemin n’y arrive pas. $site est l’origine du front-end et $claimed l’ID que la page a déclaré.
vireo_headless_allowed_origins filtre array $origins Origines autorisées à envoyer des pages vues avec la balise découplée. Part du réglage « Adresse du site front-end ».
vireo_connected_sites_limit filtre int $limit (1 par défaut) Combien de sites connectés cette installation autorise, plafonné à 100.
vireo_mainwp_enabled filtre bool $enabled (true par défaut) Renvoyez false pour empêcher un tableau de bord MainWP de lire les chiffres de ce site.
vireo_mainwp_proxied_abilities filtre string[] $names Les rapports qu’un tableau de bord MainWP peut exécuter sur ce site. Part des abilities en lecture seule de Vireo, et Pro ajoute ses rapports. Seules les abilities en lecture seule s’exécutent, quelle que soit la liste, et get-sites et get-sites-overview ne s’exécutent jamais.
// Front end serves posts under /blog/ while WordPress has them at the root.
add_filter( 'vireo_headless_post_id', function ( $post_id, $path ) {
	if ( $post_id || 0 !== strpos( $path, '/blog/' ) ) {
		return $post_id;
	}
	return url_to_postid( home_url( substr( $path, 5 ) ) );
}, 10, 2 );

API REST, abilities et MCP

Hook Type Arguments Rôle
vireo_rest_permission_callback filtre bool $allowed, WP_REST_Request $request Ajoute une condition à l’API REST. S’exécute uniquement après la réussite de la vérification de la capability : il peut donc restreindre l’accès, jamais l’élargir.
vireo_abilities_permission_callback filtre bool $allowed, array $input Pareil pour les abilities et les outils MCP.
vireo_mcp_tools filtre array $tools, noms d’abilities Les abilities proposées comme outils sur le serveur MCP. Pro ajoute les siennes via ce filtre.
vireo_mcp_server_description filtre string $description La description que le serveur MCP donne aux assistants IA quand ils se connectent.

Tableau de bord et données

Hook Type Arguments Rôle
vireo_public_dashboard_allowed filtre bool $allowed (true par défaut) Avec le tableau de bord public activé, renvoyez false pour refuser les visiteurs non connectés pour cette requête.
vireo_404_redirect_engine filtre string $engine L’outil qui conserve les redirections créées depuis Liens cassés : vireo, srm (Safe Redirect Manager), redirection ou rank-math. Part d’un plugin de redirection compatible quand il y en a un d’actif, sinon vireo. Toute autre valeur revient à vireo.
vireo_matomo_allow_private_hosts filtre bool $allow (false par défaut) Renvoyez true pour que l’import Matomo puisse joindre un Matomo situé sur un réseau privé.
vireo_statistics_reset action aucun Se déclenche après que Réinitialiser les statistiques a vidé les tables de Vireo, pour que les extensions vident les leurs.
vireo_annotation_capability filtre string $cap (edit_others_posts par défaut) La capability nécessaire pour ajouter des notes.
vireo_drivers_limit filtre int $limit Combien d’éléments en hausse et en baisse « Ce qui a changé » liste : 3 en gratuit, 10 avec Pro.
vireo_overview_card_tab filtre string $tab, callable $cb Dans quel onglet de la Vue d’ensemble apparaît la carte d’une extension accrochée à vireo_overview_after_core : content, campaigns, speed ou issues.
vireo_overview_tab_{tab} action string $start, string $end, bool $compare Affiche une carte dans un onglet de la Vue d’ensemble : vireo_overview_tab_search, _content, _campaigns, _speed ou _issues.
vireo_email_brand filtre array $brand avec logo_url (chaîne, vide par défaut), accent (couleur hexadécimale comme #0f172a, la valeur par défaut ; toute autre valeur y revient) et show_vireo (booléen, true par défaut) L’apparence du résumé par e-mail : un logo au-dessus du titre, la couleur du bouton « View full dashboard », et si le pied de page nomme Vireo Analytics. Les réglages de marque blanche de Vireo Pro l’utilisent.
vireo_hour_stats_retention_days filtre int $days (7 par défaut, 1 à 90) Combien de temps le trafic horaire est conservé pour le graphique par heure.
vireo_plausible_max_bytes filtre int $bytes (1 Go par défaut) La taille maximale à laquelle un export Plausible peut se décompresser.
vireo_after_flush action aucun Se déclenche après chaque lot de nouvelles vues arrivé dans la base de données, environ une fois par minute.
vireo_goal_completed action int $goal_id, string $visitor_hash, int $ts, float $value, string $date Se déclenche pour chaque objectif atteint au moment de son enregistrement, avec le hash salé du visiteur (vide quand il n’y en a pas), le temps Unix, la valeur de l’objectif et la date locale du site. C’est le seul endroit où une conversion porte encore son visiteur : écoutez-le pour détecter des séquences. Le hash change chaque jour et n’identifie personne.
vireo_allowed_query_vars filtre string[] $keys (page_id, p, tag, cat, product, attachment_id par défaut) Paramètres de requête conservés dans le chemin d’une page. Tous les autres sont supprimés : /pricing/?ref=mail compte donc comme /pricing/.
vireo_404_max_new_rows_per_day filtre int $max (500 par défaut) Combien de nouvelles entrées Liens cassés sont enregistrées par jour, chacune étant une adresse manquante et la page d’où elle était liée. Les visites sur des entrées déjà enregistrées ce jour-là sont toujours comptées. 0 ou moins supprime la limite.
vireo_buffer_dir_max_bytes filtre int $bytes (250 Mo par défaut) La taille maximale du dossier de données de Vireo pendant que les vues attendent d’être enregistrées, pour ce site et ses sites connectés. Au-delà, les nouvelles vues sont abandonnées jusqu’à ce que l’enregistrement rattrape son retard. Cette limite n’est atteinte que lorsque l’enregistrement s’est arrêté, ce que signale Santé du site. Voir le point de terminaison rapide.
vireo_network_activation_limit filtre int $limit (200 par défaut, 1 à 10 000) Combien de sites l’activation sur le réseau configure immédiatement. Les autres se configurent au premier chargement de l’une de leurs pages.

Fonctions

vireo_track_event( string $name, string $value = '' ): bool

Enregistre un événement personnalisé depuis PHP. Le nom ne garde que a-z, 0-9, _ et -, et le nom comme la valeur sont coupés à 100 caractères. Renvoie false si le nom est vide après nettoyage. Voir Événements et liens cassés.

Pro

Hook Type Arguments Rôle
vireo_tracked_taxonomies filtre string[] $taxonomies (category, post_tag par défaut) Les taxonomies de Principales catégories et étiquettes.
vireo_download_extensions filtre string[] $extensions, en minuscules, sans point Les types de fichiers que Pro compte comme des téléchargements.
vireo_page_vitals_retention_days filtre int $days (180 par défaut, 30 à 3650) Combien de temps la vitesse par page est conservée.
vireo_transitions_retention_days filtre int $days (90 par défaut, 1 à 730) Combien de temps les parcours de page à page sont conservés.
vireo_funnel_retention_days filtre int $days (30 par défaut, 1 à 365) Combien de temps les enregistrements des étapes d’entonnoir sont conservés.
vireo_transitions_max_new_pairs_per_day filtre int $max (2000 par défaut) Combien de nouvelles paires de pages « Où vont les gens ensuite » enregistre par jour. Les paires déjà enregistrées sont toujours comptées. 0 ou moins supprime la limite.
vireo_ai_report_content filtre string $html, array $data La partie du rapport Pro par e-mail rédigée par l’IA, avant son insertion dans l’e-mail.
vireo_ai_model_preference filtre string[] $models Les modèles que le rapport Pro par e-mail et Ask Vireo demandent à votre fournisseur d’IA, par ordre de préférence.
vireo_ask_tools filtre string[] $tools Les abilities qu’Ask Vireo peut utiliser. Seuls les noms commençant par vireo-analytics/get- sont conservés.
vireo_ask_system_prompt filtre string $prompt, string[] $tools La consigne avec laquelle Ask Vireo commence chaque question.
vireo_search_retention_days filtre int $days (90 par défaut, 7 à 730) Combien de temps les enregistrements de recherche interne sont conservés.
vireo_search_live_min_length filtre int $length (3 par défaut) Le nombre minimal de caractères qu’une saisie dans un champ de recherche en direct doit atteindre pour être enregistrée.
vireo_search_live_debounce_ms filtre int $ms (900 par défaut) Combien de temps le tracker attend après l’arrêt de la saisie avant d’enregistrer une recherche en direct.
vireo_heatmap_retention_days filtre int $days (90 par défaut, 7 à 3650) Combien de temps les données des cartes de chaleur sont conservées.
vireo_heatmap_segment_cap filtre int $cap (40 par défaut, 5 à 500) Combien de segments une carte de chaleur suit, chacun étant une combinaison de canal, de campagne, de pays et de navigateur.
vireo_pro_short_link_prefix filtre string $prefix (to par défaut) Le chemin sous lequel vivent les liens courts de campagne : /to/slug.
vireo_affiliate_patterns filtre string[] $patterns, comme /go/* Les chemins du même hôte que Pro compte comme des liens d’affiliation. Part du réglage Rapports, ou des valeurs par défaut de Pro.
vireo_content_type_values filtre array $values, type de contenu vers libellé au pluriel Les types de contenu que propose le filtre Type de contenu. Part de tous les types de contenu publics sauf les pièces jointes.
vireo_ai_crawler_alert_drop_ratio filtre float $ratio (0.10 par défaut, 0.01 à 0.9) La part des requêtes quotidiennes habituelles des robots d’IA sous laquelle chaque jour d’une baisse doit passer avant que l’alerte se déclenche.
vireo_ai_crawler_alert_min_baseline filtre float $median (20 par défaut, au moins 1) Le nombre de requêtes quotidiennes habituelles des robots d’IA qu’un site doit atteindre avant de pouvoir déclencher une alerte.
vireo_alert_webhook_allow_http filtre bool $allow (false par défaut) Renvoyez true pour accepter les adresses de webhook en http:// simple pour les alertes de trafic, en développement local.
vireo_alert_webhook_allowed_hosts filtre string[] $hosts Hôtes vers lesquels un webhook peut pointer bien qu’ils se résolvent à l’intérieur de votre réseau. Lu uniquement sur les sites locaux ou de développement, ou quand VIREO_DEV_WEBHOOK_ALLOWLIST est défini.
vireo_wpshake_endpoint filtre string $url Où vont les événements quand le canal WPShake est connecté, pour un tableau de bord auto-hébergé ou de développement.
vireo_pro_site_abilities filtre string[] $tools Les abilities qui acceptent un argument site pour les sites connectés. N’en ajoutez une que si chaque table qu’elle lit suit le site interrogé, sinon elle répond avec les chiffres de ce site.
vireo_mainwp_timeout filtre int $seconds (10 par défaut) Le temps dont dispose un enfant MainWP pour répondre à la question d’un assistant IA.