Kjeks — core plugin

101 Getting started

Install & activate

Download the latestkjeks.zip, then in WordPress go to Plugins → Add New → Upload Plugin and upload it.

• Single site: activate it from Plugins. Admin lives under Settings → Cookie Consent.
• Multisite: the plugin declares Network: true —Network Activate it. Admin lives underNetwork Admin → Settings → Cookie Consent.

Kjeks then updates itself from GitHub releases viaplugin-update-checker — new versions appear on your Plugins screen like any other update.

Show the banner & preferences

The consent banner renders automatically in the site footer. To let visitors reopen their choices or publish a cookie table, drop in a block or shortcode:

Set your content

On the Cookie Consent admin page you set the banner heading and body, your privacy-policy URL, and an accent colour. These are stored once and resolved per site.

The consent categories

Everything except necessary is denied until the visitor opts in. You can add categories with the kjeks_categories filter (see 301), but every non-necessary category is always optional.

201 Consent & integrations

Register an integration

Kjeks fires the kjeks_register_integrations action oninit (priority 20). Register your trackers inside it withkjeks_register_integration( $id, $args ) — Kjeks then holds those scripts back until the matching category is granted.

add_action( 'kjeks_register_integrations', function () {
    kjeks_register_integration( 'matomo', [
        'category'    => 'analytics',
        'label'       => 'Matomo',
        'handles'     => [ 'matomo-tracker' ],
        'src_scripts' => [
            'https://cdn.example.com/matomo.js',
            [
                'src'   => 'https://cdn.example.com/extra.js',
                'attrs' => [ 'data-site' => '7' ],
            ],
        ],
        'inline'      => [ 'console.log( "loaded after consent" );' ],
    ] );
} );

Integration arguments

Helper functions

Prefer a one-liner? These wrap the same machinery:

// Enqueue a script that only loads after a category is granted.
kjeks_enqueue_script( 'my-analytics', 'https://cdn.example.com/a.js', 'analytics' );

// Add inline JS gated by a category.
kjeks_add_inline_script( 'marketing', 'window.startPixel();' );

// Render a consent-gated embed (e.g. a YouTube iframe).
echo kjeks_embed( 'https://www.youtube.com/embed/VIDEO_ID', 'marketing' );

// Branch your own PHP on a granted category.
if ( kjeks_is_granted( 'analytics' ) ) {
    // …
}

// Output a "Cookie preferences" link that reopens the banner.
kjeks_preferences_link( 'Cookie preferences' );

Consent on the front end

The visitor's choice is stored in a cookie and localStorage under the key kjeks_consent, with a six-month lifetime. When consent changes, Kjeks dispatches events you (and add-ons) can listen for:

window.addEventListener( 'kjeks:granted', () => {
    // Fired when the visitor grants (or updates) consent.
} );

window.addEventListener( 'kjeks:withdrawn', () => {
    // Fired when the visitor withdraws consent.
} );

301 Hooks, REST & CLI

Filters

WP-CLI

wp kjeks scan-config

Generate a scanner config from the sites and paths WordPress knows about.

wp kjeks scan-config [--paths=<paths>] [--output=<file>] [--include=<ids>]

Outputs { sites: [ { url, blog_id, policy_version, paths } ] } — feed it straight to the scanner.

wp kjeks import

Import reviewed scanner observations back into the tracker inventory.

wp kjeks import <file> [--blog_id=<id>]

The file accepts either shape:

# A single site
{
  "blog_id": 1,
  "observations": [ /* … tracker observations … */ ]
}

# Or several sites at once
{
  "sites": [
    { "blog_id": 1, "observations": [ /* … */ ] },
    { "blog_id": 2, "observations": [ /* … */ ] }
  ]
}

REST API

All routes live under the kjeks/v1 namespace and require manage_network on multisite, or manage_options on a single site.

Options & tracker schema

Each tracker record carries:

id, name, category, reviewed,provider, purpose, party,storage_type, domain, path,retention, source, documentation_url,first_observed, last_observed, and sites.