ServiceTemplateTechnicalHandlingIntegration
in package
This class is only needed for the `RCB/Templates/TechnicalHandlingIntegration` filter.
Table of Contents
Properties
- $codeOptIn : string|null
- Code opt-in.
- $codeOptOut : string|null
- Code opt-out.
- $pluginData : array<string|int, mixed>
- Result of `get_plugin_data` for the integrated plugin.
- $pluginFile : string
- The plugin file which creates an integration for this template.
- $templateIdentifier : mixed
Methods
- __construct() : mixed
- C'tor.
- applyFilters() : mixed
- Run the `RCB/Templates/TechnicalHandlingIntegration` filter.
- getCodeOptIn() : mixed
- Getter.
- getCodeOptOut() : mixed
- Getter.
- getPluginName() : mixed
- Getter.
- getTemplateIdentifier() : mixed
- Getter.
- integrate() : mixed
- Checks, if the current template matches the unique identifier. It returns `true` when you as plugin developer are able to override the opt-in / opt-out scripts, otherwise it returns `false` (e.g. another plugin already created an integration for this template, the unique identifier does not match or the passed `__FILE__` is not valid).
- isIntegrated() : mixed
- Getter.
- setCodeOptIn() : mixed
- Setter.
- setCodeOptOut() : mixed
- Setter.
Properties
$codeOptIn
Code opt-in.
private
string|null
$codeOptIn
$codeOptOut
Code opt-out.
private
string|null
$codeOptOut
$pluginData
Result of `get_plugin_data` for the integrated plugin.
private
array<string|int, mixed>
$pluginData
$pluginFile
The plugin file which creates an integration for this template.
private
string
$pluginFile
$templateIdentifier
private
mixed
$templateIdentifier
Methods
__construct()
C'tor.
public
__construct(string $templateIdentifier) : mixed
Parameters
- $templateIdentifier : string
applyFilters()
Run the `RCB/Templates/TechnicalHandlingIntegration` filter.
public
static applyFilters(string $templateIdentifier) : mixed
Parameters
- $templateIdentifier : string
getCodeOptIn()
Getter.
public
getCodeOptIn() : mixed
Tags
getCodeOptOut()
Getter.
public
getCodeOptOut() : mixed
Tags
getPluginName()
Getter.
public
getPluginName() : mixed
Tags
getTemplateIdentifier()
Getter.
public
getTemplateIdentifier() : mixed
Tags
integrate()
Checks, if the current template matches the unique identifier. It returns `true` when you as plugin developer are able to override the opt-in / opt-out scripts, otherwise it returns `false` (e.g. another plugin already created an integration for this template, the unique identifier does not match or the passed `__FILE__` is not valid).
public
integrate(string $pluginFile, string $identifier) : mixed
Parameters
- $pluginFile : string
-
The
__FILE__of your main WordPress plugin file (the absolute path to youryour-plugin/your-plugin.phpfile), see also https://developer.wordpress.org/plugins/plugin-basics/header-requirements/ - $identifier : string
isIntegrated()
Getter.
public
isIntegrated() : mixed
Tags
setCodeOptIn()
Setter.
public
setCodeOptIn(string $codeOptIn) : mixed
Parameters
- $codeOptIn : string
Tags
setCodeOptOut()
Setter.
public
setCodeOptOut(string $codeOptOut) : mixed
Parameters
- $codeOptOut : string