Easy-Consent-API für Easy-Plugins

Easy Consent Entwicklung ab Version 0.8.10 Fortgeschritten

Andere Easy-Plugins können ihre Dienste an Easy Consent melden.

Das ist der bevorzugte Weg: Kein Scanner, sondern ein bewusst gepflegtes Manifest direkt im Plugin.

Registrierung per Hook

add_action( 'easy_consent_register_services', function () {
    if ( ! function_exists( 'easy_consent_register_service' ) ) {
        return;
    }

    easy_consent_register_service( [
        'plugin'            => 'easy-example',
        'service_id'        => 'google_maps',
        'label'             => 'Google Maps',
        'provider'          => 'Google Ireland Limited / Google LLC',
        'description'       => 'Zeigt eine eingebettete Karte im Frontend.',
        'category'          => 'external_media',
        'required'          => false,
        'cookies'           => 'Kann Cookies oder ähnliche Technologien durch Google setzen.',
        'loads_when'        => 'Erst nach Zustimmung oder Zwei-Klick-Freigabe.',
        'legal_basis'       => 'Einwilligung, soweit erforderlich.',
        'privacy_url'       => 'https://policies.google.com/privacy',
        'surface'           => 'frontend',
        'audience'          => 'visitor',
        'show_in_banner'    => true,
        'show_in_inventory' => true,
    ] );
} );

Wichtige Manifest-Felder

FeldBedeutung
plugintechnischer Plugin-Slug
service_idstabile eindeutige Service-ID
labelsichtbarer Dienstname
providerAnbieter
descriptionBeschreibung für Inventar und Datenschutzerklärung
categorynecessary, functional, statistics, external_media, marketing oder payment
requiredtechnisch erforderlich oder optional
cookiesCookies, Local Storage oder ähnliche Zugriffe
loads_whenwann der Dienst geladen wird
legal_basisinterne/rechtliche Einordnung
privacy_urlDatenschutzerklärung des Anbieters
surfacefrontend, admin_backend, server_side, checkout_only oder system
audiencevisitor, site_owner, editor oder system
show_in_bannerim Besucherbanner anzeigen
show_in_inventoryim Inventar anzeigen

Vor optionalem Laden prüfen

Ein Plugin sollte optionale Dienste nur laden, wenn Easy Consent sie erlaubt oder wenn eine kontrollierte Zwei-Klick-Freigabe genutzt wird.

if ( function_exists( 'easy_consent_allowed_service' )
    && easy_consent_allowed_service( 'google_maps' )
) {
    // Externen Dienst laden.
} else {
    // Platzhalter anzeigen.
}

Weiche Kopplung

Ein Easy-Plugin darf nicht hart von Easy Consent abhängen.

Deshalb immer prüfen:

if ( function_exists( 'easy_consent_register_service' ) ) {
    // Service registrieren.
}

Ohne Easy Consent darf kein Fatal Error entstehen.