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\settingsBlocker

Register content blocker custom post type.

Summary

Methods
Properties
Constants
getPluginConstantPrefix()
overrideGetOrderedCastMeta()
register_cap()
register()
revisionArray()
save_post()
deleted_post()
getOrdered()
getAllCount()
new_version_installation_after_3_0_2()
applyMetaRenameBackwardsCompatibility()
getInstance()
No public properties found
CPT_NAME
META_NAME_PRESET_ID
META_NAME_PRESET_VERSION
META_NAME_RULES
META_NAME_CRITERIA
META_NAME_TCF_VENDORS
META_NAME_SERVICES
META_NAME_IS_VISUAL
META_NAME_VISUAL_TYPE
META_NAME_VISUAL_MEDIA_THUMBNAIL
META_NAME_VISUAL_CONTENT_TYPE
META_NAME_IS_VISUAL_DARK_MODE
META_NAME_VISUAL_BLUR
META_NAME_VISUAL_DOWNLOAD_THUMBNAIL
META_NAME_VISUAL_HERO_BUTTON_TEXT
META_NAME_SHOULD_FORCE_TO_SHOW_VISUAL
DEFAULT_CRITERIA
CRITERIA_SERVICES
CRITERIA_TCF_VENDORS
DEFAULT_VISUAL_TYPE
VISUAL_TYPE_DEFAULT
VISUAL_TYPE_WRAPPED
VISUAL_TYPE_HERO
SYNC_OPTIONS_COPY
SYNC_OPTIONS_COPY_ONCE
SYNC_OPTIONS
META_KEYS
No protected methods found
No protected properties found
N/A
__construct()
$me
$cacheGetOrdered
N/A

Constants

CPT_NAME

CPT_NAME ='rcb-blocker'

META_NAME_PRESET_ID

META_NAME_PRESET_ID ='presetId'

META_NAME_PRESET_VERSION

META_NAME_PRESET_VERSION ='presetVersion'

META_NAME_RULES

META_NAME_RULES ='rules'

META_NAME_CRITERIA

META_NAME_CRITERIA ='criteria'

META_NAME_TCF_VENDORS

META_NAME_TCF_VENDORS ='tcfVendors'

META_NAME_SERVICES

META_NAME_SERVICES ='services'

META_NAME_IS_VISUAL

META_NAME_IS_VISUAL ='isVisual'

META_NAME_VISUAL_TYPE

META_NAME_VISUAL_TYPE ='visualType'

META_NAME_VISUAL_MEDIA_THUMBNAIL

META_NAME_VISUAL_MEDIA_THUMBNAIL ='visualMediaThumbnail'

META_NAME_VISUAL_CONTENT_TYPE

META_NAME_VISUAL_CONTENT_TYPE ='visualContentType'

META_NAME_IS_VISUAL_DARK_MODE

META_NAME_IS_VISUAL_DARK_MODE ='isVisualDarkMode'

META_NAME_VISUAL_BLUR

META_NAME_VISUAL_BLUR ='visualBlur'

META_NAME_VISUAL_DOWNLOAD_THUMBNAIL

META_NAME_VISUAL_DOWNLOAD_THUMBNAIL ='visualDownloadThumbnail'

META_NAME_VISUAL_HERO_BUTTON_TEXT

META_NAME_VISUAL_HERO_BUTTON_TEXT ='visualHeroButtonText'

META_NAME_SHOULD_FORCE_TO_SHOW_VISUAL

META_NAME_SHOULD_FORCE_TO_SHOW_VISUAL ='shouldForceToShowVisual'

DEFAULT_CRITERIA

DEFAULT_CRITERIA =self::CRITERIA_SERVICES

CRITERIA_SERVICES

CRITERIA_SERVICES ='services'

CRITERIA_TCF_VENDORS

CRITERIA_TCF_VENDORS ='tcfVendors'

DEFAULT_VISUAL_TYPE

DEFAULT_VISUAL_TYPE =self::VISUAL_TYPE_DEFAULT

VISUAL_TYPE_DEFAULT

VISUAL_TYPE_DEFAULT ='default'

VISUAL_TYPE_WRAPPED

VISUAL_TYPE_WRAPPED ='wrapped'

VISUAL_TYPE_HERO

VISUAL_TYPE_HERO ='hero'

SYNC_OPTIONS_COPY

SYNC_OPTIONS_COPY =array(\DevOwl\RealCookieBanner\settings\Blocker::META_NAME_RULES, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_CRITERIA, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_TCF_VENDORS, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_SERVICES, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_IS_VISUAL, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_VISUAL_TYPE, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_VISUAL_MEDIA_THUMBNAIL, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_VISUAL_CONTENT_TYPE, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_IS_VISUAL_DARK_MODE, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_VISUAL_BLUR, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_VISUAL_DOWNLOAD_THUMBNAIL, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_SHOULD_FORCE_TO_SHOW_VISUAL, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_PRESET_ID, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_PRESET_VERSION)

SYNC_OPTIONS_COPY_ONCE

SYNC_OPTIONS_COPY_ONCE =array(\DevOwl\RealCookieBanner\settings\Blocker::META_NAME_VISUAL_HERO_BUTTON_TEXT)

SYNC_OPTIONS

SYNC_OPTIONS =array('meta' => array('copy' => \DevOwl\RealCookieBanner\settings\Blocker::SYNC_OPTIONS_COPY, 'copy-once' => \DevOwl\RealCookieBanner\settings\Blocker::SYNC_OPTIONS_COPY_ONCE))

META_KEYS

META_KEYS =array(\DevOwl\RealCookieBanner\settings\Blocker::META_NAME_RULES, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_CRITERIA, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_TCF_VENDORS, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_SERVICES, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_IS_VISUAL, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_VISUAL_TYPE, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_VISUAL_MEDIA_THUMBNAIL, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_VISUAL_CONTENT_TYPE, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_IS_VISUAL_DARK_MODE, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_VISUAL_BLUR, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_VISUAL_DOWNLOAD_THUMBNAIL, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_VISUAL_HERO_BUTTON_TEXT, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_SHOULD_FORCE_TO_SHOW_VISUAL, \DevOwl\RealCookieBanner\settings\Blocker::META_NAME_PRESET_ID)

Properties

$cacheGetOrdered

$cacheGetOrdered :

Type

Methods

getPluginConstantPrefix()

getPluginConstantPrefix(): string

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

Returns

string

overrideGetOrderedCastMeta()

overrideGetOrderedCastMeta(\WP_Post  $post,array  $meta)

Documented in IOverrideBlocker.

Parameters

\WP_Post $post
array $meta

register_cap()

register_cap()

Register capabilities to administrator role to allow content blocker management.

register()

register()

Register custom post type.

revisionArray()

revisionArray(array  $result)

Modify revision array and add non-visual blockers so they trigger a new "Request new consent".

Parameters

array $result

save_post()

save_post(integer  $post_ID,\WP_Post  $post,boolean  $update)

A blocker was saved.

Parameters

integer $post_ID
\WP_Post $post
boolean $update

deleted_post()

deleted_post(integer  $postId)

A cookie got deleted, also delete all associations from content blocker.

Parameters

integer $postId

getOrdered()

getOrdered(boolean  $force = false,array<mixed,\WP_Post>  $usePosts = null): array<mixed,\WP_Post>|\WP_Error

Get all available content blocker ordered.

Parameters

boolean $force
array<mixed,\WP_Post> $usePosts

If set, only meta is applied to the passed posts

Returns

array<mixed,\WP_Post>|\WP_Error

getAllCount()

getAllCount(): integer

Get a total count of all blockers.

Returns

integer

new_version_installation_after_3_0_2()

new_version_installation_after_3_0_2(string|false  $installed)

Multiple metadata rename migrations.

Parameters

string|false $installed

applyMetaRenameBackwardsCompatibility()

applyMetaRenameBackwardsCompatibility(array  $revision,boolean  $independent)

Modify already given consents and adjust the metadata field names for "List of consents".

Parameters

array $revision
boolean $independent

getInstance()

getInstance()

Get singleton instance.

__construct()

__construct()

C'tor.