Documentation

Multisite extends AbstractMultisite

in package

• Application

implements IOverrideMultisite Uses Multisite, UtilsProvider

Consent Forwarding settings.

Table of Contents

Interfaces

IOverrideMultisite

Constants

ALL_ENDPOINT_FILTERS  = [self::ENDPOINT_FILTER_ALL, self::ENDPOINT_FILTER_NOT_CURRENT, self::ENDPOINT_FILTER_ONLY_CURRENT]

DEFAULT_CONSENT_FORWARDING  = false

DEFAULT_CROSS_DOMAINS  = ''

DEFAULT_FORWARD_TO  = ''

ENDPOINT_FILTER_ALL  = 'all'

ENDPOINT_FILTER_NOT_CURRENT  = 'notCurrent'

ENDPOINT_FILTER_ONLY_CURRENT  = 'onlyCurrent'

FORWARDING_QUERY_BLOG_ID  = 'blog'

OPTION_GROUP  = 'options'

SETTING_CONSENT_FORWARDING  = RCB_OPT_PREFIX . '-consent-forwarding'

SETTING_CROSS_DOMAINS  = RCB_OPT_PREFIX . '-cross-domains'

SETTING_FORWARD_TO  = RCB_OPT_PREFIX . '-forward-to'

Properties

$me  : Multisite

Singleton instance.

$settings  : Settings

See Settings

Methods

enableOptionsAutoload()  : mixed

Initially `add_option` to avoid autoloading issues.

getAvailableEndpoints()  : array<string|int, mixed>

Get all available and predefined endpoints within this environment. E. g. if your are running within a mulitisite, you will get all available WP REST API endpoints for each site within this multisite. That means, you need to add your endpoint as follows: `$endpoints["https://example.com/wp-json/real-cookie-banner/v1/consent/forward"] = 'My example'.`

getConfiguredEndpoints()  : array<string|int, string>

Get the available endpoints which are part of this environment and active for the consent forwarding. Examples:

getCrossDomains()  : array<string|int, string>

Get forward to external URLs.

getEnvironmentHost()  : string

Get current host for the current environment where consent is processed.

getExternalHosts()  : array<string|int, string>

Check if external hosts need to be contacted and return the external hosts including subdomain.

getForwardTo()  : array<string|int, string>

Get forward to URLs within the network.

getInstance()  : Multisite

Get singleton instance.

getPluginConstantPrefix()  : string

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

getSettings()  : mixed

Getter.

isConsentForwarding()  : bool

Check if consent should be forwarded.

mapDecisionToUniqueNames()  : array<string|int, string>

Transform a given consent decision (groups with service IDs) to a map of unique names.

mapUniqueNamesToDecision()  : mixed

Transform a given consent decision in string[] (`uniqueName`) to a map of groups with cookie ids.

overrideEnableOptionsAutoload()  : mixed

overrideRegister()  : mixed

register()  : mixed

Register settings.

setSettings()  : mixed

Setter.

updated_option_forward_to()  : mixed

The option "Forward to" got updated. Let's iterate all available sites and activate consent forwarding automatically.

__construct()  : mixed

C'tor.