DevOwl

CacheInvalidate

caches

Customize

controls

DeliverAnonymousAsset

FastHtmlTag

finder

match

Freemium

HeadlessContentBlocker

finder

match

StyleInlineAttributeMatch

StyleInlineAttributeFinder

matcher

plugins

imagePreview

scanner

Multilingual

RealCookieBanner

base

comp

language

Hooks

migration

import

lite

comp

language

Hooks

presets

blocker

rest

settings

view

blocker

customize

banner

overrides

interfce

settings

presets

free

blocker

middleware

pro

blocker

rest

scanner

settings

view

blockable

BlockerPostType

blocker

checklist

customize

banner

individual

navmenu

shortcode

RealProductManagerWpClient

announcement

client

license

rest

view

RealQueue

queue

rest

Queue

RealUtils

cross

view

Options

TcfVendorListNormalize

MatthiasWeb

Utils

\DevOwl\RealCookieBanner\viewBanner

Main banner.

Summary

Methods

Properties

Constants

getPluginConstantPrefix()
admin_bar_menu()
shouldLoadAssets()
isPreventPreDecision()
wp_head()
localizeGroups()
modifySkipIfActive()
wp_footer()
isHiddenDueLegal()
getCustomize()
instance()

No public properties found

DESIGN_VERSION
ACTION_CLEAR_CURRENT_COOKIE
HTML_ATTRIBUTE_SKIP_IF_ACTIVE
HTML_ATTRIBUTE_SKIP_WRITE
HTML_ATTRIBUTE_UNIQUE_WRITE_NAME
HTML_ATTRIBUTE_SKIP_LAZY_LOADING_PLUGINS

poweredLink()

No protected properties found

N/A

__construct()

$customize

N/A

Constants

DESIGN_VERSION

DESIGN_VERSION =2

The design version is incremented each time, we need to distinguish between some UI elements within our cookie banner and content blockers. For example, in a recent version of Real Cookie Banner we removed the footer for content blockers completely, but to be compliant with our documentation we still want to show footers for older consents in our "List of consents".

ACTION_CLEAR_CURRENT_COOKIE

ACTION_CLEAR_CURRENT_COOKIE ='rcb-clear-current-cookie'

HTML_ATTRIBUTE_SKIP_IF_ACTIVE

HTML_ATTRIBUTE_SKIP_IF_ACTIVE ='skip-if-active'

HTML_ATTRIBUTE_SKIP_WRITE

HTML_ATTRIBUTE_SKIP_WRITE ='skip-write'

HTML_ATTRIBUTE_UNIQUE_WRITE_NAME

HTML_ATTRIBUTE_UNIQUE_WRITE_NAME ='unique-write-name'

Example:

<script unique-write-name="gtag">console.log("this gets written to DOM");</script>
<script unique-write-name="gtag">console.log("this gets skipped");</script>

HTML_ATTRIBUTE_SKIP_LAZY_LOADING_PLUGINS

HTML_ATTRIBUTE_SKIP_LAZY_LOADING_PLUGINS ='data-skip-lazy-load="js-extra"'

For "Code on page load" we need to ensure no other plugin is lazy loading it. E.g.

WP Rocket transforms inline scripts to rocketlazyloadscript.

js-extra is a common string which does caching plugins or lazy loading plugins ignore as it is similar to the wp_localize_script output tag.

Properties

$customize

$customize :\DevOwl\RealCookieBanner\view\BannerCustomize

The customize handler

Type

\DevOwl\RealCookieBanner\view\BannerCustomize

Methods

getPluginConstantPrefix()

getPluginConstantPrefix(): string

Get the prefix of this plugin so composer packages can dynamically build other constant values on it.

Returns

string

Inherited from: \DevOwl\RealCookieBanner\base\UtilsProvider

Tags

codeCoverageIgnore	It only returns a string with the constant prefix

admin_bar_menu()

admin_bar_menu(\WP_Admin_Bar  $admin_bar)

Show a "Show banner again" button in the admin toolbar in frontend.

Parameters

\WP_Admin_Bar

$admin_bar

shouldLoadAssets()

shouldLoadAssets(string  $context)

Checks if the banner is active for the current page. This does not check any user relevant conditions because they need to be done in frontend (caching).

Parameters

string

$context

The context passed to Assets#enqueue_script_and_styles

isPreventPreDecision()

isPreventPreDecision()

Determine if the current page should not handle a predecision.

See also useBannerPreDecisionGateway.tsx.

wp_head()

wp_head()

The `codeOnPageLoad` can be directly rendered to the Output Buffer cause it does not stand in conflict with any caching plugin (no conditional rendering).

localizeGroups()

localizeGroups()

Localize available cookie groups for frontend.

modifySkipIfActive()

modifySkipIfActive(string  $html,string  $identifier = null)

Make `skip-if-active` work with comma-separated list of active plugins. That means, if a given plugin is active it automatically skips the HTML tag.

Parameters

string	$html
string	$identifier	The preset identifier (can be `null`)

wp_footer()

wp_footer()

Print out the overlay so it is server-side rendered (avoid flickering as early as possible).

See also inlineStyle.tsx#overlay for more information!

isHiddenDueLegal()

isHiddenDueLegal()

Checks if the overlay should be hidden due to legal setting. E. g. hide cookie banner on imprint page. This is also a port of `useHiddenDueLegal.tsx`.

getCustomize()

getCustomize()

Getter.

Inherited from: \DevOwl\RealCookieBanner\view\Banner