Aller au contenu

Développeurs

← Documentation

Ce que vous pouvez faire ici

  • Placer la politique de cookies et un lien « Gérer les cookies » dans votre thème, avec des codes courts.
  • Retenir vos propres scripts jusqu’au consentement, et réagir au choix du visiteur, avec JavaScript.
  • Modifier les textes, les catégories, les cookies connus et l’apparence du bandeau, avec des filtres PHP et du CSS.
  • Vous créez une extension ou un thème ? Facilitez le consentement : noms des cookies, stockage, WP Consent API.

Cette section liste chaque code court, crochet, route REST, constante et événement JavaScript des extensions, et indique quelle extension fournit chacun.

Deux extensions

Cookie Rocks AuditCookie Rocks Pro
PrixGratuitPayante, avec un essai gratuit
Dossier de l’extensioncookie-rockscookie-rocks-banner
Constante définie quand elle est activeCOOKIE_ROCKS_VERSIONCOOKIE_ROCKS_BANNER_VERSION
Domaine de textecookie-rockscookie-rocks-banner
Sur les pages de vos visiteursRien, sauf la politique de cookies là où vous placez son code courtLe bandeau, le bouton cookie, le blocage des traceurs, les signaux de consentement

Cookie Rocks Pro s’appuie sur l’Audit. Sans l’Audit actif, il ne fait rien sur votre site et propose de l’installer. Les deux extensions gardent leurs réglages dans une seule option partagée, cookie_rocks_settings, et partagent le menu Cookie Rocks.

Pour exécuter du code seulement quand Pro est présent :

if ( defined( 'COOKIE_ROCKS_BANNER_VERSION' ) ) {
	// Cookie Rocks Pro is active: the banner, window.CookieRocks and the PHP filters of the banner exist.
}

Ce que vous pouvez utiliser

PageAuditPro
Codes courts[cookie_rocks_policy][cookie_rocks_policy], [cookie_rocks_link], et les autres moyens de rouvrir les choix
Filtres PHP, actions et API RESTFiltres sur les catégories, les cookies connus, les nouveautés et les vérifications ; une action après chaque page d’administrationFiltres sur les textes, la configuration, Google Consent Mode, l’optimisation, les pages protégées et les pages avec un formulaire ; une action pour les comptes gérés hors de WordPress ; trois routes REST, pour le registre des preuves et les règles par pays
API JavaScript et événementsAucun : l’Audit n’ajoute aucun script pour les visiteurswindow.CookieRocks, événements du DOM, événements de Google Tag Manager, retenue de vos propres scripts et cadres
CSS (ci-dessous)Aucun : la politique prend le style de votre thèmeVariables et classes du bandeau

La page Développeurs de l’administration liste les 842 outils dont Cookie Rocks connaît les cookies. Pour un outil qu’il ne connaît pas, retenez son script avec quelques attributs HTML, ou ajoutez-le au catalogue avec le filtre cookie_rocks_services.

Constantes
ConstanteDéfinie parExtensionUsage
COOKIE_ROCKS_VERSIONL’extensionAuditVersion de l’Audit. Définie quand l’Audit est actif.
COOKIE_ROCKS_BANNER_VERSIONL’extensionProVersion de Cookie Rocks Pro. Définie quand Pro est actif.
COOKIE_ROCKS_APIVous, dans wp-config.phpProUne autre adresse pour le service des clés de Cookie Rocks, pour des essais. Pro y envoie alors chaque appel lié à la clé, comme sa confirmation et la recherche de mises à jour. Terminez-la par une barre oblique. Laissez-la non définie sur un site en ligne.
SCRIPT_DEBUGVous, dans wp-config.phpProUne constante de WordPress. Quand elle vaut true, Cookie Rocks Pro sert ses scripts et feuilles de style lisibles au lieu des versions minifiées.
// wp-config.php, test site only.
define( 'COOKIE_ROCKS_API', 'https://keys.example.test/wp-json/cookierocks/v1/' );

Modifier l’apparence avec du CSS

Ceci concerne le bandeau de Cookie Rocks Pro. Commencez par la page Apparence : couleurs, coins, distance aux bords et ombres y sont des réglages. Utilisez le CSS pour ce que la page ne propose pas.

  1. Ouvrez l’endroit où votre site garde son propre CSS : Apparence, Personnaliser, CSS additionnel (thèmes classiques), Apparence, Éditeur, Styles, CSS additionnel (thèmes blocs), le champ de CSS personnalisé de votre thème ou de votre constructeur de pages, ou votre thème enfant.
  2. Écrivez vos règles sur .cr-root[data-theme], pour qu’elles s’appliquent dans les thèmes clair et sombre.
  3. Pour une variable que la page Apparence règle aussi, ajoutez !important. Voir pourquoi ci-dessous.
/* Square corners and a lighter shadow, in light and dark themes */
.cr-root[data-theme] {
	--cr-radius: 6px !important;
	--cr-shadow: 0 8px 24px rgba(0, 0, 0, .12);
}

/* Buttons in capital letters */
.cr-root .cr-btn {
	text-transform: uppercase;
	letter-spacing: .04em;
}

Si votre valeur CSS est ignorée. Le bandeau écrit les valeurs choisies sur la page Apparence dans l’attribut style de .cr-root : --cr-accent, --cr-accent-text, --cr-accent-ink, --cr-accent-dark (quand l’accent manque de contraste dans le thème sombre), --cr-radius, --cr-gap, --cr-sh quand Ombres est désactivé, --cr-ring (couleur de l’anneau du bouton cookie) et la place du bouton cookie. Ces valeurs en ligne l’emportent sur votre feuille de style. Une valeur laissée par défaut n’est pas écrite : une règle sans !important ne fonctionne donc que tant que ce réglage reste à sa valeur par défaut (par exemple Coins arrondis à 20). Ajoutez !important, ou modifiez le réglage sur la page Apparence.

Variables
VariableCe qu’elle règle
--cr-accentCouleur d’accent : boutons et interrupteurs. Réglez-la sur la page Apparence.
--cr-accent-textTexte sur la couleur d’accent. Choisi automatiquement pour rester lisible.
--cr-bgFond du bandeau et du détail.
--cr-fgTexte principal.
--cr-mutedTexte secondaire.
--cr-lineBordures et séparations.
--cr-softFonds clairs : le bouton « Je choisis », les catégories.
--cr-trackInterrupteurs désactivés.
--cr-shadowOmbre du bandeau et des détails. Quand Ombres est désactivé, aucune ombre n’est affichée, quelle que soit cette valeur.
--cr-radiusCoins arrondis, en pixels (de 0 à 32, 20 par défaut). Réglez-les sur la page Apparence.
--cr-gapDistance entre le bandeau et les bords de l’écran, en pixels (de 0 à 40, 20 par défaut). Réglez-la avec Distance aux bords de l’écran sur la page Apparence. À 0, la boîte se place dans le coin. La disposition en barre ne l’utilise pas. Sur les téléphones, la distance est de 8 px au plus.
Classes
ClasseCe que c’est
.cr-rootContient tout. Attributs : data-theme (auto, light, dark), data-layout (box, bar, et minimal pour la boîte discrète), data-position (left, right).
.cr-bannerLe bandeau.
.cr-eyebrow, .cr-title, .cr-textNom du site, titre et texte du bandeau.
.cr-btn--solidBoutons « Tout refuser » et « Tout accepter » (même apparence, comme la loi l’exige). Avec Mettre en avant « Tout accepter » sur la page Apparence, « Tout refuser » devient .cr-btn--outline.
.cr-btn--softBouton « Je choisis ».
.cr-dialogLa fenêtre du détail, avec .cr-cat pour chaque catégorie et .cr-switch pour les interrupteurs.
.cr-widgetLe bouton cookie.
.cr-toastLe court message après un choix.
.cr-form-noticeLa demande affichée au-dessus des formulaires protégés par reCAPTCHA.
.cr-manage-linkLe lien « Gérer les cookies » du code court.

Les espaces réservés des vidéos et des cartes sont dessinés dans leur propre cadre : ils suivent la couleur d’accent, pas votre CSS.

Test against the next version: the beta channel

Check your plugin or theme against the next Cookie Rocks before it ships. On a test site, add this line to wp-config.php, and WordPress offers the beta versions in its usual updates:

define( 'COOKIE_ROCKS_CHANNEL', 'beta' );
  • It works for Cookie Rocks Pro, and for the Audit installed from cookierocks.com. The Audit installed from WordPress.org only receives stable versions.
  • The site then follows the most recent version, beta or stable.
  • To go back, remove the line: WordPress offers the next stable version. Going back to an older version is not automatic: reinstall the stable version by hand if you need it.
  • Test sites only: a beta can still change before the stable version. Tell our support about anything that breaks.

Étape suivante : Codes courts

fin du oui
Le oui dure des mois. Le cookie peut rester des années.Durée des cookies →
Vous écrivez le code ?Durée des cookies : bonnes pratiques pour les développeurs →
Vous faites une extension ou un thème ?Vérifiez les noms de vos cookies et de vos clés de stockage avant de publier. Un nom déjà pris, ou trop générique, est classé et bloqué avec celui d’un autre.
Pour les développeurs d’extensions et de thèmes →