Action Reference - Backend
Liste aller Action Hooks im Backend von Borlabs Cookie.
Content Blocker
borlabsCookie/contentBlocker/edit/template/settings/{$content_blocker_id}
Erlaubt das Hinzufügen zusätzlicher Eingabefelder zu einem Content Blocker.
$contentBlockerData enthält alle Informationen des aktuellen Content Blockers.
add_action('borlabsCookie/contentBlocker/edit/template/settings/my-content-blocker', function ($contentBlockerData) {
$inputCustomValue = esc_html(!empty($contentBlockerData->settings['customValue']) ? $contentBlockerData->settings['customValue'] : '');
echo '<div class="form-group row">'
echo '<label for="customValue" class="col-sm-4 col-form-label">Custom Value</label>';
echo '<div class="col-sm-8">'
echo '<input type="text" class="form-control form-control-sm d-inline-block w-75 mr-2" id="customValue" name="settings[customValue]" value="'.$inputCustomValue.'">';
echo '<span data-toggle="tooltip" title="Your Tooltip Text"><i class="fas fa-lg fa-question-circle text-dark"></i></span>';
echo '</div>';
echo '</div>';
});
borlabsCookie/contentBlocker/edit/template/settings/help/{$content_blocker_id}
Erlaubt das Hinzufügen zusätzlicher Eingabefelder zu einem Content Blocker.
$contentBlockerData enthält alle Informationen des aktuellen Content Blockers.
add_action('borlabsCookie/contentBlocker/edit/template/settings/help/my-content-blocker', function ($contentBlockerData) {
echo '<div class="col-12 col-md-4 rounded-right shadow-sm bg-tips text-light">'
echo '<div class="px-3 pt-3 pb-3 mb-4">'
echo '<h3 class="border-bottom mb-3">Tips</h3>';
echo '<h4>How My Content Blocker works</h4>';
echo '<p>Lorem ipsum dolor.</p>';
echo '</div>';
echo '</div>';
});
Cookies
borlabsCookie/cookie/edit/template/settings/{$service}
Erlaubt das Hinzufügen zusätzlicher Eingabefelder zu einem Cookie Service.
$cookieData enthält alle Informationen des aktuellen Cookies.
add_action('borlabsCookie/cookie/edit/template/settings/MyService', function ($cookieData) {
$inputCustomValue = esc_html(!empty($cookieData->settings['customValue']) ? $cookieData->settings['customValue'] : '');
echo '<div class="form-group row">'
echo '<label for="customValue" class="col-sm-4 col-form-label">Custom Value</label>';
echo '<div class="col-sm-8">'
echo '<input type="text" class="form-control form-control-sm d-inline-block w-75 mr-2" id="customValue" name="settings[customValue]" value="'.$inputCustomValue.'">';
echo '<span data-toggle="tooltip" title="Your Tooltip Text"><i class="fas fa-lg fa-question-circle text-dark"></i></span>';
echo '</div>';
echo '</div>';
});
borlabsCookie/cookie/edit/template/settings/help/{$service}
Erlaubt das Hinzufügen eines Tipps-Bereiches zu einem Cookie Service.
$cookieData enthält alle Informationen des aktuellen Cookies.
add_action('borlabsCookie/cookie/edit/template/settings/help/MyService', function ($cookieData) {
echo '<div class="col-12 col-md-4 rounded-right shadow-sm bg-tips text-light">'
echo '<div class="px-3 pt-3 pb-3 mb-4">'
echo '<h3 class="border-bottom mb-3">Tips</h3>';
echo '<h4>How MyService works</h4>';
echo '<p>Lorem ipsum dolor.</p>';
echo '</div>';
echo '</div>';
});
Filter Reference - Backend
Liste aller Filter im Backend von Borlabs Cookie.
Content Blocker
borlabsCookie/contentBlocker/save
Erlaubt das Modifizieren der Content Blocker Daten vor dem Speichern.
add_filter('borlabsCookie/contentBlocker/save', function ($formData) {
// Sanitize or modify $formData, e.g. $formData['settings']['customValue']
return $formData;
});
borlabsCookie/contentBlocker/validate
Erlaubt das Validieren der Content Blocker Daten vor dem Speichern.
add_filter('borlabsCookie/contentBlocker/validate', function ($errorStatus, $formData) {
// Validate $formData, e.g. $formData['settings']['customValue']
// Set $errorStatus true, if data is not valid. Do not set $errorStatus false!
return $errorStatus;
}, 10, 2);
Cookies
borlabsCookie/cookie/service/defaultData
Erlaubt das Festlegen der Standardwerte eines neuen Services.
add_filter('borlabsCookie/cookie/service/defaultData', function ($serviceDefaultData, $formData) {
// Check if the selected service is your service
if (!empty($formData['service']) && $formData['service'] === 'MyService') {
// $serviceDefaultData has to contain these informations
$serviceDefaultData = [
'cookieId' => 'my-service',
'service' => 'MyService',
'name' => 'My Service',
'provider' => '',
'purpose' => '',
'privacyPolicyURL' => '',
'hosts' => [],
'cookieName' => '',
'cookieExpiry' => '',
'optInJS' => '',
'optOutJS' => '',
'fallbackJS' => '',
'settings' => [
'customValue' => '',
],
'status' => true,
'undeletetable' => false,
];
}
return $serviceDefaultData;
}, 10, 2);
borlabsCookie/cookie/save
Erlaubt das Modifizieren der Cookie Daten vor dem Speichern.
add_filter('borlabsCookie/cookie/save', function ($formData) {
// Sanitize or modify $formData, e.g. $formData['settings']['customValue']
return $formData;
});
borlabsCookie/cookie/service/selection
Erlaubt das Hinzufügen eines Services in die Liste der auswählbaren Services.
add_filter('borlabsCookie/cookie/service/selection', function ($cookieServices) {
// Add your service to the list of services
$cookieServices['MyService'] = 'My Service';
return $cookieServices;
});
borlabsCookie/cookie/validate
Erlaubt das Validieren der Cookie Daten vor dem Speichern.
add_filter('borlabsCookie/cookie/validate', function ($errorStatus, $formData) {
// Validate $formData, e.g. $formData['settings']['customValue']
// Set $errorStatus true, if data is not valid. Do not set $errorStatus false!
return $errorStatus;
}, 10, 2);
Cookie Gruppen
borlabsCookie/contentBlocker/save
Erlaubt das Modifizieren der Daten der Cookie Gruppe vor dem Speichern.
add_filter('borlabsCookie/cookieGroup/save', function ($formData) {
// Sanitize or modify $formData, e.g. $formData['settings']['customValue']
return $formData;
});
borlabsCookie/contentBlocker/validate
Erlaubt das Validieren der Daten der Cookie Gruppe vor dem Speichern.
add_filter('borlabsCookie/cookieGroup/validate', function ($errorStatus, $formData) {
// Validate $formData, e.g. $formData['settings']['customValue']
// Set $errorStatus true, if data is not valid. Do not set $errorStatus false!
return $errorStatus;
}, 10, 2);
Filter Reference - Frontend
Liste aller Filter im Frontend von Borlabs Cookie.
Content Blocker
borlabsCookie/contentBlocker/modify/content/{$content_blocker_id}
Erlaubt das Modifizieren der Vorschau des blockierten Inhaltes sowie des blockierten Inhaltes selbst.
add_filter('borlabsCookie/contentBlocker/modify/content/my-service', function ($content) {
// Get settings of the Content Blocker
$contentBlockerData = BorlabsCookieHelper()->getContentBlockerData('my-service');
// Do what ever you have to do
// Return the preview of the blocked content
return $contentBlockerData['previewHTML'];
});
borlabsCookie/contentBlocker/modify/settings/{$content_blocker_id}
Erlaubt das Modifizieren der zusätzlichen Einstellungen des Content Blockers.
add_filter('borlabsCookie/contentBlocker/modify/settings/my-service', function ($settings) {
// Modify $settings, e.g. $settings['customValue']
return $settings;
});
Cookie Einstellungen
borlabsCookie/settings
Erlaubt das Modifizieren der Einstellungen der JavaScript API von Borlabs Cookie.
add_filter('borlabsCookie/settings', function ($jsConfig) {
// Modify the JavaScript API config of Borlabs Cookie, e.g. $jsConfig['showCookieBox']
return $jsConfig;
});
Cross Domain Cookies
borlabsCookie/crossDomainCookie/language
Erlaubt die übermittelte Sprache auf der Ziel-Seite zu überschreiben.
add_filter('borlabsCookie/crossDomainCookie/language', function ($language) {
// Overwrite the language code
return $language;
});
borlabsCookie/crossDomainCookie/consents
Erlaubt das Modifizieren der Einwilligungen für das Cookie auf der Ziel-Seite.
add_filter('borlabsCookie/crossDomainCookie/consents', function ($consents, $cookieData) {
// Modify the given and already cleaned consents. $cookieData includes all transmitted data
return $consents;
}, 10, 2);
System
borlabsCookie/javascript/disabledOnRestRequest
Bei REST-Abfragen werden keine JavaScript-Dateien über wp_enqueue_script registriert, mit Hilfe des Filters kann dies deaktiviert werden.
add_filter('borlabsCookie/javascript/disabledOnRestRequest', function () {
// Enqueue Borlabs Cookie JavaScript files on REST request.
return false;
});
borlabsCookie/style/disabledOnRestRequest
Bei REST-Abfragen werden keine CSS-Dateien über wp_enqueue_script registriert, mit Hilfe des Filters kann dies deaktiviert werden.
add_filter('borlabsCookie/style/disabledOnRestRequest', function () {
// Enqueue Borlabs Cookie CSS files on REST request.
return false;
}, 10, 2);