30 days free. No credit card. Full access from the moment you connect your site.

Start free trial

Get Banner Status

consent/get-banner-status reports on the banner visitors actually receive: whether it has been built, how large it is in each language, and whether a rebuild is pending.

This is the ability to reach for when a consent change appears not to have taken effect.

At a glance

Abilityconsent/get-banner-status
ToolsetCookieYes — toolset/cookieyes
GroupCookieYes › The Banner
RequiresCookieYes, active on the site
Capabilitymanage_options
SafetyRead-only — changes nothing
RepeatableIdempotent — running it twice leaves the same result
Ships inAcrossAI Abilities Manager 0.0.34 and later

How it works

The banner a visitor receives is not assembled on the fly. It is cached HTML, built from the declared cookies, the consent categories and the settings, and rebuilt only when the consent plugin’s own save hooks fire. Write the consent tables any other way — through the database abilities, through another plugin — and the row reads back correctly while every visitor still sees the previous banner, with no error anywhere to say so.

That gap is what this reads. The declared cookies are one thing; the built HTML is another; and this reports on the second. A pending rebuild means the two have diverged and visitors are still on the old version.

The per-language sizes are a blunt but effective check. A banner that is several kilobytes in English and zero in German has a build problem for German visitors, and no screen in the admin will tell you that.

Worth running after anything that wrote the consent tables outside this suite — a database ability, a migration, another plugin.

Input

This ability takes no input.

What comes back

NameTypeWhat it is
languagesarrayThe languages the banner is built for.
renderedobjectThe size of the built banner, per language.
pending_rebuildbooleanWhether a rebuild is outstanding.
banner_enabledbooleanWhether the banner is switched on at all.
successbooleanWhether the call completed.
messagestringA one-line summary of what happened, suitable for showing a human.
error_codestringPresent only on failure — a stable machine-readable reason, such as a missing field, a wrong field type or an unmet confirmation.

Example

Ask your assistant:

Is the cookie banner actually showing our latest changes?

It resolves to one call:

{
  "ability": "consent/get-banner-status",
  "parameters": {}
}

Worth knowing

  • pending_rebuild true means stored changes are not being served yet.
  • A language with a zero-size banner is broken for visitors in that language.
  • banner_enabled false means no banner at all, whatever the rest says.
  • Run consent/rebuild-banner to repair a stale build.

Related abilities


Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager

Browse the rest: Every ability, by category


Keep reading