API Documentation
\
DevOwl
CacheInvalidate
caches
Customize
controls
DeliverAnonymousAsset
FastHtmlTag
finder
match
Freemium
HeadlessContentBlocker
finder
match
matcher
plugins
imagePreview
scanner
Multilingual
RealCookieBanner
base
comp
language
migration
import
lite
comp
language
presets
blocker
rest
settings
view
blocker
customize
banner
overrides
interfce
settings
presets
free
blocker
middleware
pro
blocker
rest
scanner
settings
view
blockable
blocker
checklist
customize
banner
individual
navmenu
shortcode
RealProductManagerWpClient
announcement
client
license
rest
view
RealQueue
queue
rest
RealUtils
cross
view
TcfVendorListNormalize
MatthiasWeb
Utils

\DevOwl\RealCookieBanner\settingsGeneral

General settings.

Summary

Methods
Properties
Constants
overrideEnableOptionsAutoload()
overrideRegister()
getAdditionalPageHideIds()
getSetCookiesViaManager()
getPluginConstantPrefix()
enableOptionsAutoload()
register()
isBannerActive()
isBlockerActive()
getImprintPageUrl()
getPrivacyPolicyUrl()
getDefaultPrivacyPolicy()
getPermalinkMap()
delete_post_imprint_privacy_policy()
update_option_wp_page_for_privacy_policy()
update_option_privacy_policy()
getInstance()
enableOptionAutoload()
No public properties found
OPTION_GROUP
SETTING_BANNER_ACTIVE
SETTING_BLOCKER_ACTIVE
SETTING_IMPRINT_ID
SETTING_IMPRINT_EXTERNAL_URL
SETTING_IMPRINT_IS_EXTERNAL_URL
SETTING_PRIVACY_POLICY_ID
SETTING_PRIVACY_POLICY_EXTERNAL_URL
SETTING_PRIVACY_POLICY_IS_EXTERNAL_URL
SETTING_HIDE_PAGE_IDS
SETTING_SET_COOKIES_VIA_MANAGER
DEFAULT_BANNER_ACTIVE
DEFAULT_BLOCKER_ACTIVE
DEFAULT_IMPRINT_ID
DEFAULT_IMPRINT_EXTERNAL_URL
DEFAULT_IMPRINT_IS_EXTERNAL_URL
DEFAULT_PRIVACY_POLICY_ID
DEFAULT_PRIVACY_POLICY_EXTERNAL_URL
DEFAULT_PRIVACY_POLICY_IS_EXTERNAL_URL
DEFAULT_HIDE_PAGE_IDS
DEFAULT_SET_COOKIES_VIA_MANAGER
No protected methods found
No protected properties found
N/A
__construct()
$me
N/A

Constants

OPTION_GROUP

OPTION_GROUP ='options'

SETTING_BANNER_ACTIVE

SETTING_BANNER_ACTIVE =RCB_OPT_PREFIX . '-banner-active'

SETTING_BLOCKER_ACTIVE

SETTING_BLOCKER_ACTIVE =RCB_OPT_PREFIX . '-blocker-active'

SETTING_IMPRINT_ID

SETTING_IMPRINT_ID =\DevOwl\RealCookieBanner\view\customize\banner\Legal::SETTING_IMPRINT

SETTING_IMPRINT_EXTERNAL_URL

SETTING_IMPRINT_EXTERNAL_URL =\DevOwl\RealCookieBanner\view\customize\banner\Legal::SETTING_IMPRINT_EXTERNAL_URL

SETTING_IMPRINT_IS_EXTERNAL_URL

SETTING_IMPRINT_IS_EXTERNAL_URL =\DevOwl\RealCookieBanner\view\customize\banner\Legal::SETTING_IMPRINT_IS_EXTERNAL_URL

SETTING_PRIVACY_POLICY_ID

SETTING_PRIVACY_POLICY_ID =\DevOwl\RealCookieBanner\view\customize\banner\Legal::SETTING_PRIVACY_POLICY

SETTING_PRIVACY_POLICY_EXTERNAL_URL

SETTING_PRIVACY_POLICY_EXTERNAL_URL =\DevOwl\RealCookieBanner\view\customize\banner\Legal::SETTING_PRIVACY_POLICY_EXTERNAL_URL

SETTING_PRIVACY_POLICY_IS_EXTERNAL_URL

SETTING_PRIVACY_POLICY_IS_EXTERNAL_URL =\DevOwl\RealCookieBanner\view\customize\banner\Legal::SETTING_PRIVACY_POLICY_IS_EXTERNAL_URL

SETTING_HIDE_PAGE_IDS

SETTING_HIDE_PAGE_IDS =RCB_OPT_PREFIX . '-hide-page-ids'

SETTING_SET_COOKIES_VIA_MANAGER

SETTING_SET_COOKIES_VIA_MANAGER =RCB_OPT_PREFIX . '-set-cookies-via-manager'

DEFAULT_BANNER_ACTIVE

DEFAULT_BANNER_ACTIVE =false

DEFAULT_BLOCKER_ACTIVE

DEFAULT_BLOCKER_ACTIVE =true

DEFAULT_IMPRINT_ID

DEFAULT_IMPRINT_ID =\DevOwl\RealCookieBanner\view\customize\banner\Legal::DEFAULT_IMPRINT

DEFAULT_IMPRINT_EXTERNAL_URL

DEFAULT_IMPRINT_EXTERNAL_URL =\DevOwl\RealCookieBanner\view\customize\banner\Legal::DEFAULT_IMPRINT_EXTERNAL_URL

DEFAULT_IMPRINT_IS_EXTERNAL_URL

DEFAULT_IMPRINT_IS_EXTERNAL_URL =\DevOwl\RealCookieBanner\view\customize\banner\Legal::DEFAULT_IMPRINT_IS_EXTERNAL_URL

DEFAULT_PRIVACY_POLICY_ID

DEFAULT_PRIVACY_POLICY_ID =\DevOwl\RealCookieBanner\view\customize\banner\Legal::DEFAULT_PRIVACY_POLICY

DEFAULT_PRIVACY_POLICY_EXTERNAL_URL

DEFAULT_PRIVACY_POLICY_EXTERNAL_URL =\DevOwl\RealCookieBanner\view\customize\banner\Legal::DEFAULT_PRIVACY_POLICY_EXTERNAL_URL

DEFAULT_PRIVACY_POLICY_IS_EXTERNAL_URL

DEFAULT_PRIVACY_POLICY_IS_EXTERNAL_URL =\DevOwl\RealCookieBanner\view\customize\banner\Legal::DEFAULT_PRIVACY_POLICY_IS_EXTERNAL_URL

DEFAULT_HIDE_PAGE_IDS

DEFAULT_HIDE_PAGE_IDS =''

DEFAULT_SET_COOKIES_VIA_MANAGER

DEFAULT_SET_COOKIES_VIA_MANAGER ='none'

Properties

Methods

overrideEnableOptionsAutoload()

overrideEnableOptionsAutoload()

overrideRegister()

overrideRegister()

getAdditionalPageHideIds()

getAdditionalPageHideIds()

getSetCookiesViaManager()

getSetCookiesViaManager()

getPluginConstantPrefix()

getPluginConstantPrefix(): string

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

Returns

string

enableOptionsAutoload()

enableOptionsAutoload()

Initially `add_option` to avoid autoloading issues.

register()

register()

Register settings.

isBannerActive()

isBannerActive(): boolean

Is the banner active?

Returns

boolean

isBlockerActive()

isBlockerActive(): boolean

Is the content blocker active?

Returns

boolean

getImprintPageUrl()

getImprintPageUrl(mixed  $default = false): string

Get the imprint page URL.

Parameters

mixed $default

Returns

string

getPrivacyPolicyUrl()

getPrivacyPolicyUrl(mixed  $default = false): string

Get the privacy policy page URL.

Parameters

mixed $default

Returns

string

getDefaultPrivacyPolicy()

getDefaultPrivacyPolicy()

Get default privacy policy post ID.

getPermalinkMap()

getPermalinkMap()

Return a map of `post_id` to permalink URL for imprint and privacy policy.

delete_post_imprint_privacy_policy()

delete_post_imprint_privacy_policy(\DevOwl\RealCookieBanner\settings\number  $postId)

When a page gets deleted, check if the value is our configured imprint or privacy policy page and reset the value accordingly.

Parameters

\DevOwl\RealCookieBanner\settings\number $postId

update_option_wp_page_for_privacy_policy()

update_option_wp_page_for_privacy_policy(integer  $old_value,integer  $new_value)

When Settings > Privacy got adjusted, apply the new privacy policy to the cookie settings, too.

Parameters

integer $old_value
integer $new_value

update_option_privacy_policy()

update_option_privacy_policy(integer  $old_value,integer  $new_value)

When the privacy policy page gets adjusted, let's update the Real Cookie Banner services including the WPML/PolyLang translations.

Parameters

integer $old_value
integer $new_value

enableOptionAutoload()

enableOptionAutoload(string  $optionName,mixed  $default,callable  $filter = null)

Add an option to autoloading and also with default.

Parameters

string $optionName
mixed $default
callable $filter

__construct()

__construct()

C'tor.