Entwickler-Dokumentation | Impressum Plus

Ab Version 1.1.0 von Impressum Plus gibt es eine Vielzahl an Möglichkeiten, die Ausgabe der einzelnen Inhalte zu ändern.

Allgemeine Filter

`impressum_admin_default_tab`

Über den Filter impressum_admin_default_tab kann der standardmäßig aktive Tab geändert werden, der beim Aufruf der Impressumseinstellungen im Backend angezeigt wird.

Parameter:
string $default_tab Der Standard-Tab (Standardwert: imprint)

Erwartet einen String zurück.

Beispiel

function my_impressum_admin_default_tab( $default_tab ) {
	return 'my-tab';
}

add_filter( 'impressum_admin_default_tab', 'my_impressum_admin_default_tab' );Code-Sprache: PHP (php)

`impressum_admin_tab`

Über den Filter impressum_admin_tab können die Tabs im Backend verändert werden.

Parameter:
array $tabs Die Tabs im Backend
string $form_action Die Action des Formulars innerhalb des Tabs
string $current_tab Der aktuell aktive Tab

Erwartet ein Array zurück.

Beispiel

function my_impressum_admin_tab( $tabs, $form_action, $current_tab ) {
	$slug = 'my-tab';
	
	// get content
	ob_start();
	echo '<div class="nav-tab-content' . ( $current_tab === $slug ? ' nav-tab-content-active' : '' ) . '" id="nav-tab-content-' . esc_attr( $slug ) . '">';
	echo '<form action="' . esc_html( $form_action ) . '" method="post">';
	// output security fields for the registered setting "impressum"
	settings_fields( 'impressum_' . $slug );
	// output setting sections and their fields
	// (sections are registered for "impressum", each field is registered to a specific section)
	do_settings_sections( 'impressum_' . $slug );
	// output save settings button
	submit_button( __( 'Save Settings', 'impressum-plus' ) );
	echo '</form>';
	echo '</div>';
	
	$tabs[] = [
		'content' => ob_get_clean(),
		'slug' => $slug,
		'title' => __( 'My Tab', 'impressum-plus' ),
	];
	
	return $tabs;
}

add_filter( 'impressum_admin_tab', 'my_impressum_admin_tab', 10, 3 );Code-Sprache: PHP (php)

`impressum_api_api_args`

Über den Filter impressum_api_api_args können die die Parameter der einzelnen Felder innerhalb der API verändert werden.

Parameter:
array $api_args Die Parameter der API

Erwartet ein Array zurück.

Beispiel

function my_impressum_api_api_args( $api_args ) {
	// get $settings_fields from somewhere with each field
	// having a sub-index 'api' for API related information
	
	foreach ( $settings_fields as $key => $settings_field ) {
		if ( empty( $settings_field['api'] ) ) continue;
		
		$my_args[ $key ] = $settings_field['api'];
	}
	
	return $my_args;
}

add_filter( 'impressum_api_api_args', 'my_impressum_api_api_args' );Code-Sprache: PHP (php)

`impressum_api_option_name`

Über den Filter impressum_api_option_name kann der Name der Option, der über die API ausgegeben/verändert werden soll, verändert werden.

Parameter:
string $option_name Der Name der Option
\WP_REST_Request $request Das aktuelle Anfrage-Objekt (ab 2.3.0)

Erwartet einen String zurück.

Beispiel

function my_impressum_api_option_name( $option_name, $request ) {
	return 'my_option';
}

add_filter( 'impressum_api_option_name', 'my_impressum_api_option_name', 10, 2 );Code-Sprache: PHP (php)

`impressum_api_option_sub_key`

ab 2.3.0

Über den Filter impressum_api_option_sub_key kann der Name des Schlüssels einer Option, die über die API ausgegeben/verändert werden soll, verändert werden.

Parameter:
string $sub_key Der Name des Schlüssels
\WP_REST_Request $request Das aktuelle Anfrage-Objekt

Erwartet einen String zurück.

Beispiel

function my_impressum_api_option_name( $sub_key, $request ) {
	return 'name';
}

add_filter( 'impressum_api_option_sub_key', 'my_impressum_api_option_name', 10, 2 );Code-Sprache: PHP (php)

`impressum_api_tab_content`

Über den Filter impressum_api_tab_content kann der Inhalt des Tabs „API“ im Backend verändert werden.

Parameter:
string $content Der Inhalt des Tabs „API“

Erwartet einen String zurück.

Beispiel

function my_impressum_api_tab_content( $content ) {
	// do stuff with content
	
	// then
	return $content;
}

add_filter( 'impressum_api_tab_content', 'my_impressum_api_tab_content' );Code-Sprache: PHP (php)

`impressum_country_after_sort`

Über den Filter impressum_country_after_sort können die Länder verändert werden, nachdem sie sortiert werden.

Parameter:
array $countries Die Top 50 Länder alphabetisch sortiert

Erwartet ein Array zurück.

Beispiel

function my_impressum_country_after_sort( $countries ) {
	$countries['grl'] = __( 'Greenland', 'my-textdomain' );
	
	return $countries;
}

add_filter( 'impressum_country_after_sort', 'my_impressum_country_after_sort' );Code-Sprache: PHP (php)

`impressum_country_pre_sort`

Über den Filter impressum_country_pre_sort können die Länder verändert werden, bevor sie sortiert werden.

Parameter:
array $countries Die Top 50 Länder

Erwartet ein Array zurück.

Beispiel

function my_impressum_country_pre_sort( $countries ) {
	$countries['grl'] = __( 'Greenland', 'my-textdomain' );
	
	return $countries;
}

add_filter( 'impressum_country_pre_sort', 'my_impressum_country_pre_sort' );Code-Sprache: PHP (php)

`impressum_disabled_backend`

Über den Filter impressum_disabled_backend kann gesteuert werden, ob das Backend nicht angezeigt werden soll (gegebenenfalls sinnvoll, wenn per API gesteuert).

Parameter:
bool $disabled_backend true, wenn das Backend nicht angezeigt werden soll, sonst false (Standard: false)

Erwartet einen bool’schen Wert zurück.

Beispiel

add_filter( 'impressum_disabled_backend', '__return_true' );Code-Sprache: PHP (php)

`impressum_disabled_notice`

Über den Filter impressum_disabled_notice kann gesteuert werden, ob der Hinweis im Backend, wenn ein Impressum noch nicht vollständig ausgefüllt wurde, nicht angezeigt werden soll.

Parameter:
bool $disabled_notice true, wenn der Hinweis nicht angezeigt werden soll, sonst false (Standard: false)

Erwartet einen bool’schen Wert zurück.

Beispiel

add_filter( 'impressum_disabled_notice', '__return_true' );Code-Sprache: PHP (php)

`impressum_imprint_tab_content`

Über den Filter impressum_imprint_tab_content kann der Inhalt des Tabs „Impressum“ im Backend verändert werden.

Parameter:
string $content Der Inhalt des Tabs „Impressum“

Erwartet einen String zurück.

Beispiel

function my_impressum_imprint_tab_content( $content ) {
	// do stuff with content
	
	// then
	return $content;
}

add_filter( 'impressum_imprint_tab_content', 'my_impressum_imprint_tab_content' );Code-Sprache: PHP (php)

`impressum_legal_entity_after_sort`

Über den Filter impressum_legal_entity_after_sort können die Rechtsformen verändert werden, nachdem sie sortiert werden.

Parameter:
array $legal_entities Die Rechtsformen alphabetisch sortiert

Erwartet ein Array zurück.

Beispiel

function my_impressum_legal_entity_after_sort( $legal_entities ) {
	$legal_entities['other'] = __( 'Other', 'my-textdomain' );
	
	return $legal_entities;
}

add_filter( 'impressum_legal_entity_after_sort', 'my_impressum_legal_entity_after_sort' );Code-Sprache: PHP (php)

`impressum_legal_entity_pre_sort`

Über den Filter impressum_legal_entity_pre_sort können die Rechtsformen verändert werden, bevor sie sortiert werden.

Parameter:
array $legal_entities Die Rechtsformen

Erwartet ein Array zurück.

Beispiel

function my_impressum_legal_entity_pre_sort( $legal_entities ) {
	$legal_entities['other'] = __( 'Other', 'my-textdomain' );
	
	return $legal_entities;
}

add_filter( 'impressum_legal_entity_pre_sort', 'my_impressum_legal_entity_pre_sort' );Code-Sprache: PHP (php)

`impressum_privacy_settings_fields`

Über den Filter impressum_privacy_settings_fields können die Einstellungsfelder, die im Backend im Tab „Datenschutz“ angezeigt und später ausgegeben werden, verändert werden.

Parameter:
array $settings_fields Die aktuellen Datenschutz-Einstellungsfelder

Erwartet ein Array zurück.

Beispiel

function my_impressum_privacy_settings_fields( $settings_fields ) {
	// add a custom settings field
	$settings_fields['my_field'] = [
		'title' => __( 'My Field', 'my-textdomain' ),
		'callback' => 'text_callback', // function name or function
		'page' => 'impressum_privacy',
		'section' => 'impressum_section_privacy_general',
		'args' => [
			'label_for' => 'my_field',
			'class' => 'impressum_row',
			'description' => __( 'Optional description for my field', 'my-textdomain' ),
		],
		'api' => [
			'description' => esc_html__( 'The checkbox whether my field is being used.', 'my-textdomain' ),
			'type' => 'text',
		],
	];
	
	return $settings_fields;
}

add_filter( 'impressum_privacy_settings_fields', 'my_impressum_privacy_settings_fields' );Code-Sprache: PHP (php)

`impressum_privacy_tab_content`

Über den Filter impressum_privacy_tab_content kann der Inhalt des Tabs „Datenschutz“ im Backend verändert werden.

Parameter:
string $content Der Inhalt des Tabs „Datenschutz“

Erwartet einen String zurück.

Beispiel

function my_impressum_privacy_tab_content( $content ) {
	// do stuff with content
	
	// then
	return $content;
}

add_filter( 'impressum_privacy_tab_content', 'my_impressum_privacy_tab_content' );Code-Sprache: PHP (php)

`impressum_settings_fields`

Über den Filter impressum_settings_fields können die Einstellungsfelder, die im Backend angezeigt und später ausgegeben werden, verändert werden.

Parameter:
array $settings_fields Die aktuellen Einstellungsfelder

Erwartet ein Array zurück.

Beispiel

function my_impressum_settings_fields( $settings_fields ) {
	// add a custom settings field
	$settings_fields['my_field'] = [
		'title' => __( 'My Field', 'my-textdomain' ),
		'callback' => 'impressum_input_text_callback', // function name or function
		'page' => 'impressum_imprint',
		'section' => 'impressum_section_imprint',
		'args' => [
			'label_for' => 'my_field',
			'class' => 'impressum_row',
			'description' => __( 'Optional description for my field', 'my-textdomain' ),
			'required' => true,	
		],
		'api' => [
			'description' => esc_html__( 'The checkbox whether my field is being used.', 'my-textdomain' ),
			'type' => 'text',
		],
	];
	
	return $settings_fields;
}

add_filter( 'impressum_settings_fields', 'my_impressum_settings_fields' );Code-Sprache: PHP (php)

Filter Datenschutzerklärung

Die nachfolgenden Filter sind in Reihenfolge ihres Auftretens geordnet.

`impressum_privacy_has_content` veraltet 2.11.0

Über den Filter impressum_privacy_has_content kannst du die Prüfung, ob ein Abschnitt einen Inhalt enthält, überschreiben.

Veraltet seit 2.11.0, verwende stattdessen impressum_privacy_is_active_policy.

Parameter:
string $option_name Der Optionsname, der getestet wird

Erwartet einen bool’schen Wert zurück.

`impressum_privacy_is_active_policy` seit 2.11.0

Über den Filter impressum_privacy_is_active_policy kannst du die Prüfung, ob ein Abschnitt einen Inhalt enthält, überschreiben.

Parameter:
string $option_name Der Optionsname, der getestet wird
mixed[] $options Liste an verfügbaren Optionen und deren Inhalt

Erwartet einen bool’schen Wert zurück.

`impressum_privacy_policy_content_{$category}` seit 2.11.0

Über den Filter impressum_privacy_policy_content_{$category} kannst du den Inhalt der Datenschutzerklärung einer bestimmten Kategorie filtern.

Parameter:
string $policies Der Text der aktuellen Kategorie
int $headline_number Die Nummer der aktuellen Überschrift

Erwartet einen String zurück.

`impressum_privacy_${this}_content`

Über den Filter impressum_privacy_${this}_content kann der Inhalt des aktuellen Bereichs in der Datenschutzerklärung verändert werden.

Seit 2.11.0 ist das Übergeben eines Arrays mit den Schlüsseln content und headline_number veraltet.

Parameter:
string $policy_general Der allgemeine Inhalt der Datenschutzerklärung
int $headline_number Die aktuelle Überschriften-Nummer der Datenschutzerklärung

Erwartet einen String zurück.

Beispiel

function my_impressum_privacy_general_content( $content ) {
	// do stuff with content
	
	// then
	return $content;
}

add_filter( 'impressum_privacy_general_content', 'my_impressum_privacy_general_content' );Code-Sprache: PHP (php)

`impressum_privacy_policy_content`

Über den Filter impressum_privacy_policy_content kann der Inhalt der gesamten Datenschutzerklärung verändert werden.

Parameter:
string $policy_content Die Datenschutzerklärung

Erwartet einen String zurück.

Beispiel

function my_impressum_privacy_policy_content( $content ) {
	// do stuff with content
	
	// then
	return $content;
}

add_filter( 'impressum_privacy_policy_content', 'my_impressum_privacy_policy_content' );Code-Sprache: PHP (php)

Filter Datenschutzerklärung Systemprüfung

Bei der Systemprüfung versucht Impressum Plus, automatisch zu erkennen, ob bestimmte Inhalte auf der Website verbaut sind und zeigt dementsprechend Inhalte in der Datenschutzerklärung automatisch ein oder blendet sie aus.

Nach der Änderung über einen der unten stehenden Filter kann man die Prüfung forcieren, indem man im Backend die Datenschutz-Einstellungen erneut speichert.

`impressum_privacy_{$option}_slugs`

Über den Filter impressum_privacy_{$option}_slugs kann der Inhalt der zu überprüfenden Plugins in der Systemprüfung für die jeweilige Option verändert werden.

Parameters:
string[] $slugs Die aktuellen Plugin-Titelformen
string $option Der Name der Option, die geprüft wird

Erwartet ein Array.

Example

function my_impressum_privacy_contact_form_slugs( $slugs ) {
	// add slug
	$slugs[] = 'my-plugin/my-plugin.php';
	
	// then
	return $slugs;
}

add_filter( 'impressum_privacy_contact_form_slugs', 'my_impressum_privacy_contact_form_slugs' );Code-Sprache: PHP (php)

`impressum_privacy_contact_form_slugs`

See impressum_privacy_${option}_slugs.

`impressum_privacy_google_ads_slugs`

See impressum_privacy_${option}_slugs.

`impressum_privacy_shop_slugs`

See impressum_privacy_${option}_slugs.

`impressum_privacy_comment_subscription_slugs`

See impressum_privacy_${option}_slugs.

`impressum_privacy_contact_form_slugs`

See impressum_privacy_${option}_slugs.

`impressum_privacy_google_ads_slugs`

See impressum_privacy_${option}_slugs.

`impressum_privacy_shop_slugs`

See impressum_privacy_${option}_slugs.

`impressum_privacy_comment_subscription_slugs`

See impressum_privacy_${option}_slugs.

Allgemeine Filter

impressum_admin_default_tab

Beispiel

impressum_admin_tab

Beispiel

impressum_api_api_args

Beispiel

impressum_api_option_name

Beispiel

impressum_api_option_sub_key

Beispiel

impressum_api_tab_content

Beispiel

impressum_country_after_sort

Beispiel

impressum_country_pre_sort

Beispiel

impressum_disabled_backend

Beispiel

impressum_disabled_notice

Beispiel

impressum_imprint_tab_content

Beispiel

impressum_legal_entity_after_sort

Beispiel

impressum_legal_entity_pre_sort

Beispiel

impressum_privacy_settings_fields

Beispiel

impressum_privacy_tab_content

Beispiel

impressum_settings_fields

Beispiel

Filter Datenschutzerklärung

impressum_privacy_has_content veraltet 2.11.0

impressum_privacy_is_active_policy seit 2.11.0

impressum_privacy_policy_content_{$category} seit 2.11.0

impressum_privacy_${this}_content

Beispiel

impressum_privacy_general_content

impressum_privacy_required_content

impressum_privacy_ssl_content

impressum_privacy_responsible_content

impressum_privacy_definition_content

impressum_privacy_legal_basis_content

impressum_privacy_dpf_content seit 2.7.0

impressum_privacy_logfile_content

impressum_privacy_cookie_content

impressum_privacy_consent_manager_content

impressum_privacy_tracking_content

impressum_privacy_gtm_content

impressum_privacy_ads_content

impressum_privacy_google_maps_content

impressum_privacy_google_fonts_content

impressum_privacy_youtube_content

impressum_privacy_vimeo_content

impressum_privacy_facebook_pixel_content

impressum_privacy_additional_tracking_content

impressum_privacy_contact_content

impressum_privacy_comment_content

impressum_privacy_cleantalk_content seit 2.7.0

impressum_privacy_social_sharing_content

impressum_privacy_register_content

impressum_privacy_newsletter_content

impressum_privacy_embed_privacy_content

impressum_privacy_spotify_content seit 2.7.0

impressum_privacy_storage_time_content

impressum_privacy_rights_content

impressum_privacy_paypal_content

impressum_privacy_stripe_content

impressum_privacy_mollie_content

impressum_privacy_dhl_content

impressum_privacy_jobs_content

impressum_privacy_amazon_partner_content

impressum_privacy_policy_content

Beispiel

Filter Datenschutzerklärung Systemprüfung

impressum_privacy_{$option}_slugs

Example

impressum_privacy_contact_form_slugs

`impressum_admin_default_tab`

`impressum_admin_tab`

`impressum_api_api_args`

`impressum_api_option_name`

`impressum_api_option_sub_key`

`impressum_api_tab_content`

`impressum_country_after_sort`

`impressum_country_pre_sort`

`impressum_disabled_backend`

`impressum_disabled_notice`

`impressum_imprint_tab_content`

`impressum_legal_entity_after_sort`

`impressum_legal_entity_pre_sort`

`impressum_privacy_settings_fields`

`impressum_privacy_tab_content`

`impressum_settings_fields`

`impressum_privacy_has_content` veraltet 2.11.0

`impressum_privacy_is_active_policy` seit 2.11.0

`impressum_privacy_policy_content_{$category}` seit 2.11.0

`impressum_privacy_${this}_content`

`impressum_privacy_general_content`

`impressum_privacy_required_content`

`impressum_privacy_ssl_content`

`impressum_privacy_responsible_content`

`impressum_privacy_definition_content`

`impressum_privacy_legal_basis_content`

`impressum_privacy_dpf_content` seit 2.7.0

`impressum_privacy_logfile_content`

`impressum_privacy_cookie_content`

`impressum_privacy_consent_manager_content`

`impressum_privacy_tracking_content`

`impressum_privacy_gtm_content`

`impressum_privacy_ads_content`

`impressum_privacy_google_maps_content`

`impressum_privacy_google_fonts_content`

`impressum_privacy_youtube_content`

`impressum_privacy_vimeo_content`

`impressum_privacy_facebook_pixel_content`

`impressum_privacy_additional_tracking_content`

`impressum_privacy_contact_content`

`impressum_privacy_comment_content`

`impressum_privacy_cleantalk_content` seit 2.7.0

`impressum_privacy_social_sharing_content`

`impressum_privacy_register_content`

`impressum_privacy_newsletter_content`

`impressum_privacy_embed_privacy_content`

`impressum_privacy_spotify_content` seit 2.7.0

`impressum_privacy_storage_time_content`

`impressum_privacy_rights_content`

`impressum_privacy_paypal_content`

`impressum_privacy_stripe_content`

`impressum_privacy_mollie_content`

`impressum_privacy_dhl_content`

`impressum_privacy_jobs_content`

`impressum_privacy_amazon_partner_content`

`impressum_privacy_policy_content`

`impressum_privacy_{$option}_slugs`

`impressum_privacy_contact_form_slugs`

`impressum_privacy_google_ads_slugs`

`impressum_privacy_shop_slugs`

`impressum_privacy_comment_subscription_slugs`

`impressum_privacy_contact_form_slugs`

`impressum_privacy_google_ads_slugs`

`impressum_privacy_shop_slugs`

`impressum_privacy_comment_subscription_slugs`