Dokumentation · Admin-Referenz
Referenz für den Einrichtungsassistenten
Dieses Dokument ist eine Referenz für den Ersteinrichtungs-Assistenten (First Setup Wizard) des ADP Car Market Hub-Plugins. Der Assistent ist ein sechsstufiger Onboarding-Prozess im Enterprise-Stil, der einen WordPress-Administrator dabei unterstützt, die am häufigsten genutzten Konfigurationsaufgaben direkt nach der ersten Aktivierung abzuschließen.
Der Assistent ist optional. Jede Option, die er bietet, kann auch manuell über die regulären Admin-Tabs konfiguriert werden, die an anderer Stelle im Administrator-Handbuch dokumentiert sind. Die empfohlene Reihenfolge für die Ersteinrichtung finden Sie unter Ersteinrichtung.
Wann Sie dieses Dokument verwenden sollten
Lesen Sie dieses Dokument, wenn Sie Folgendes tun müssen:
- Verstehen, wann und wie der Willkommenshinweis für den Setup-Assistenten erscheint.
- Wissen, wie Sie den Assistenten starten, überspringen oder fortsetzen.
- Den Unterschied zwischen der Demo-Einrichtung und der Live-AutoScout24-Einrichtung verstehen.
- Wissen, welche Optionen der Assistent schreibt und welche Optionen er niemals stillschweigend überschreibt.
- Das Sicherheitsmodell verstehen (Berechtigungs- und Nonce-Schutz, Handhabung des Client Secret).
- Den Assistenten für eine interne Übergabe oder ein Kunden-Onboarding-Verfahren dokumentieren.
Übersicht
Der Assistent ist als versteckte Admin-Seite unter folgender Adresse registriert:
wp-admin/admin.php?page=as24ci-setup-wizard
Er ist nicht im Untermenü von Car Market Hub aufgeführt. Die Einstiegspunkte sind:
- Der Admin-Hinweis Willkommen bei ADP Car Market Hub, der nach der ersten Aktivierung erscheint.
- Der Link Setup-Assistenten ausführen im oberen Bereich von
Car Market Hub → Dashboard. - Die Karte Setup-Assistent oben in
Car Market Hub → Tools.
Der Assistent leitet nach der Aktivierung niemals automatisch weiter. Der Admin-Hinweis dient lediglich der Information und bietet zwei Schaltflächen: Setup-Assistenten starten und Vorerst überspringen.
Voraussetzungen oder Vorbedingungen
- Ein WordPress-Benutzer mit der Verwaltungsberechtigung des Plugins (
Plugin::CAP_MANAGE). - Ein Zeitstempel der Erstaktivierung, der vom Aktivierungs-Hook des Plugins aufgezeichnet wurde. Bestehende Installationen, die ohne Reaktivierung aktualisiert werden, sehen den Willkommenshinweis nicht, können den Assistenten aber dennoch manuell über das Dashboard oder den Tools-Tab öffnen.
- Für die Live-Einrichtung: AutoScout24-API-Zugangsdaten (Client ID, Client Secret, Seller ID, API-Basis-URL).
- Für die Demo-Einrichtung: Es sind keine API-Zugangsdaten erforderlich.
Ablauf des Assistenten
Schritt 1 — Modus
Wählen Sie zwischen zwei Einrichtungspfaden:
- Demo-Einrichtung — installiert eine kuratierte Auswahl an Demofahrzeugen, wendet demofreundliche Standardwerte an und aktiviert vorab das Analytics-Häkchen, damit die Dashboard- und Analytics-Seiten Daten zum Anzeigen haben. Die Demo-Einrichtung ist ein expliziter Reset- und Seed-Vorgang: Sie löst nach dem Abschluss den bestehenden Pfad
Demo_Data::install()aus. - Live-AutoScout24-Einrichtung — speichert echte AutoScout24-Zugangsdaten sowie die ausgewählten Seiten und Funktions-Toggles, installiert jedoch keine Demodaten und aktiviert Analytics nicht vorab.
Schritt 1 erfasst außerdem das Land des Autohauses (DE, CH, AT, Andere), die Standard-Währung (EUR, CHF) und die Admin-Sprache (Website-Standard plus eine kleine explizite Whitelist).
Schritt 2 — Autohaus-Profil
Erfasst grundlegende Identitätsdaten des Autohauses, die von anderen Teilen des Plugins verwendet werden: Name, Straße, Postleitzahl, Ort, Land, Telefon, E-Mail, Website und eine Logo-Medien-ID. Alle Felder sind optional. Übermittelte Werte werden bereinigt; leer gelassene Felder behalten den vorhandenen gespeicherten Wert bei (kein Feld wird stillschweigend gelöscht).
Schritt 3 — AutoScout24
Erfasst die AutoScout24-API-Verbindung: Client ID, Client Secret, Seller ID und API-Basis-URL. Im Demo-Modus zeigt dieser Schritt einen Hinweis zum Überspringen an; im Live-Modus werden Zugangsdaten empfohlen.
Das Feld Client Secret wird absichtlich leer dargestellt. Der Assistent schreibt das gespeicherte Secret niemals in das Admin-HTML zurück. Wenn Sie das Formular abschicken und dieses Feld leer lassen (oder nur Leerzeichen enthält), bleibt das vorhandene gespeicherte Secret erhalten. Das Absenden eines nicht leeren Wertes ersetzt es. Dieselbe Regel gilt für den regulären Einstellungen-Tab — siehe Einstellungs-Referenz.
Die Basis-URL wird mit einer Whitelist für http/https abgeglichen; andere Schemata (z. B. javascript:) werden abgelehnt.
Schritt 4 — Seiten
Für jede öffentlich zugängliche Seite bietet der Assistent drei Modi an:
- Automatisch erstellen —
wp_insert_post()wird mitpost_type=page,post_status=publish, dem kanonischen Titel und dem kanonischen Shortcode als Seiteninhalt aufgerufen. Zuerst wird eine Titelsuche durchgeführt, um die Erstellung eines Duplikats zu vermeiden, falls bereits eine Seite mit demselben Titel existiert. - Bestehende Seite verwenden — der Administrator gibt die Post-ID einer bestehenden Seite ein und die entsprechende Option (
as24ci_page_archive_id,as24ci_page_compare_id,as24ci_page_favorites_id) wird aktualisiert. - Überspringen — die Seite wird nicht erstellt und der vorhandene Optionswert bleibt erhalten.
Kanonische Seiten und Shortcodes:
| Seite | Shortcode | Option |
|---|---|---|
| Fahrzeuge | [as24ci_archive] | as24ci_page_archive_id |
| Fahrzeuge vergleichen | [as24ci_compare] | as24ci_page_compare_id |
| Favoriten | [as24ci_favorites] | as24ci_page_favorites_id |
Wenn die Option bereits auf eine bestehende Seite verweist (get_post() gibt eine veröffentlichte Seite zurück), behält der Assistent diese bei und erstellt kein Duplikat. Der Assistent löscht niemals bestehende Seiten.
Suchaufträge haben im Assistenten absichtlich keine öffentliche Seite. Suchauftrag-Abonnements werden über die Filter-Seitenleiste von [as24ci_archive] und über den Admin-Tab Suchaufträge-Referenz verwaltet.
Schritt 5 — Funktionen
Schaltet die gängigsten Standardfunktionen ein oder aus. Jedes Toggle wird mit einer expliziten Markierung für das Vorhandensein aufgezeichnet, sodass ein erneutes Ausführen des Assistenten auf halbem Weg niemals eine Einstellung löscht, die nicht im Formular enthalten war:
- Social-Sharing-Buttons
- PDF-Datenblatt
- QR-Code im PDF
- Betriebskosten pro 100 km
- Vergleichen
- Favoriten
- Suchaufträge
- Analytics-Tracking
Im Demo-Modus ist das Analytics-Häkchen vorab aktiviert. Im Live-Modus ist es deaktiviert, es sei denn, der Administrator aktiviert es explizit.
Versteckte Standardwerte, auf die sich der Assistent verlässt (Platzierung des Social Sharings, das vollständige Netzwerk-Set, Archiv-Layout = beide, Listen-Auszug = 150), werden nur dann eingespielt, wenn die entsprechende Option fehlt; bestehende Werte werden beibehalten.
Schritt 6 — Fertigstellen
Eine schreibgeschützte Zusammenfassung der getroffenen Entscheidungen. Im Demo-Modus ist die Schaltfläche zum Fertigstellen mit Demodaten installieren und fertigstellen beschriftet und löst den bestehenden Pfad Demo_Data::install() aus. Im Live-Modus speichert die Schaltfläche zum Fertigstellen nur die vom Assistenten gesammelten Einstellungen.
Nach erfolgreichem Abschluss:
as24ci_setup_wizard_completedwird gesetzt.as24ci_setup_completed_atwird auf einen ISO-8601 UTC-Zeitstempel gesetzt.as24ci_setup_completed_bywird auf die WordPress-Benutzer-ID gesetzt.- Der Administrator wird mit einer Erfolgsmeldung zurück zum Dashboard geleitet.
Verhalten des Admin-Hinweises
Der Willkommenshinweis wird nur gerendert, wenn alle folgenden Bedingungen erfüllt sind:
- Der aktuelle Benutzer verfügt über die Verwaltungsberechtigung des Plugins.
as24ci_setup_first_activation_atexistiert (wird vonPlugin::activate()nur aufgezeichnet, wenn es fehlt, sodass bestehende Installationen, die ohne Reaktivierung aktualisiert werden, nicht belästigt werden).as24ci_setup_wizard_completedist nicht gesetzt.as24ci_setup_wizard_skippedist nicht gesetzt.- Der aktuelle Bildschirm ist nicht die Seite des Assistenten selbst.
Es werden zwei Schaltflächen angeboten:
- Setup-Assistenten starten öffnet den Assistenten.
- Vorerst überspringen sendet Daten an
admin-post.php?action=as24ci_setup_wizard_skip(mit Berechtigungs- und Nonce-Prüfungen). Es setztas24ci_setup_wizard_skipped=1und leitet zurück zum Dashboard weiter. Der Hinweis erscheint bei nachfolgenden Ladevorgängen von Admin-Seiten nicht mehr.
Der Assistent erzwingt nach der Aktivierung niemals eine Weiterleitung.
Konfigurations-Referenz
Status-Optionen
| Option | Zweck |
|---|---|
as24ci_setup_first_activation_at | Zeitstempel der Erstaktivierung. Einmalig über add_option() aufgezeichnet; wird bei späteren (Re-)Aktivierungen niemals überschrieben. |
as24ci_setup_wizard_completed | Wird nach erfolgreichem Abschluss auf 1 gesetzt. |
as24ci_setup_wizard_skipped | Wird auf 1 gesetzt, wenn der Administrator im Willkommenshinweis auf „Überspringen“ klickt. |
as24ci_setup_mode | Entweder demo oder live. |
as24ci_setup_completed_at | ISO-8601 UTC-Zeitstempel des Abschluss-Ereignisses. |
as24ci_setup_completed_by | WordPress-Benutzer-ID, die den Assistenten abgeschlossen hat. |
Optionen für das Autohaus-Profil
as24ci_dealer_name, as24ci_dealer_street, as24ci_dealer_postal_code, as24ci_dealer_city, as24ci_dealer_country, as24ci_dealer_phone, as24ci_dealer_email, as24ci_dealer_website, as24ci_dealer_logo_id, as24ci_dealer_language.
Bestehende Optionen, die der Assistent beschreiben kann
CLIENT_ID, CLIENT_SECRET, SELLER_IDS, BASE_URL, DEFAULT_CURRENCY, FEATURE_SOCIAL_SHARE, SOCIAL_SHARE_PLACEMENT, SOCIAL_SHARE_NETWORKS, FEATURE_PDF_DATASHEET, FEATURE_COMPARE, FEATURE_FAVORITES, FEATURE_SEARCH_AGENT, ANALYTICS_ENABLED, ENVKV_SHOW_COSTS_100KM, PDF_MANAGER_SETTINGS (Schlüssel show_qr), DESIGN_ARCHIVE_LAYOUT, ARCHIVE_LIST_EXCERPT_LENGTH, as24ci_page_archive_id, as24ci_page_compare_id, as24ci_page_favorites_id.
Der Assistent aktualisiert nur Optionen, deren Formularfelder tatsächlich in den übermittelten POST-Daten enthalten sind. Nicht übermittelte Felder behalten ihren vorhandenen Wert.
Sicherheit
- Berechtigungsprüfung. Jeder Einstiegspunkt (die Seite des Assistenten, der Handler zum Speichern des Formulars und der Handler zum Überspringen) ruft
current_user_can( Plugin::CAP_MANAGE )auf und bricht mitwp_die()ab, wenn die Berechtigung fehlt. - Nonces. Das Speichern des Formulars verwendet
wp_nonce_field()/check_admin_referer(); die URL zum Überspringen verwendetwp_nonce_url()/check_admin_referer(). - Client Secret. Das gespeicherte Secret wird niemals im Admin-HTML ausgegeben. Leere Übermittlungen oder Übermittlungen, die nur Leerzeichen enthalten, behalten den gespeicherten Wert bei.
- URL-Validierung. Die Basis-URL und die Website des Autohauses müssen das Schema
httpoderhttpsverwenden; andere Schemata werden abgelehnt. - E-Mail-Validierung. Die E-Mail-Adresse des Autohauses wird mit
is_email()validiert. Ungültige Eingaben behalten stillschweigend den vorhandenen Wert bei; eine leere Übermittlung löscht ihn. - Bereinigung (Sanitization). Modus, Land, Währung, Sprache und Seitenmodus werden mit expliziten Whitelists abgeglichen. Textfelder verwenden
sanitize_text_field(). Seiten-IDs verwendenabsint(). - Ausgabe-Maskierung (Output Escaping). Jeder dynamische Wert, der vom Assistenten gerendert wird, verwendet
esc_html,esc_attroderesc_url.
Betriebliche Hinweise
- Der Assistent ändert niemals Einstellungen bei der Aktivierung des Plugins. Die Aktivierung spielt lediglich zerstörungsfreie Standardwerte über
add_option()ein. - Der Assistent ändert niemals Einstellungen, wenn ein Schritt geladen wird — Einstellungen werden nur aktualisiert, wenn der Administrator einen Schritt abschickt.
- Die Demo-Einrichtung bleibt ein expliziter Reset- und Seed-Vorgang: Sie setzt demo-gesteuerte Optionen bewusst zurück und fügt Demofahrzeuge ein. Verwenden Sie diese Option nur auf dedizierten Demo- oder Test-Websites.
- Die Live-Einrichtung ist in Bezug auf Fahrzeuge und Kundeneinstellungen zerstörungsfrei. Sie speichert die vom Assistenten ausgewählten Einstellungen und Seiten, installiert jedoch keine Demodaten.
- Analytics ist nur im Demo-Modus vorab aktiviert. Im Live-Modus ist das Toggle ein Opt-in. Siehe Analytics-Aufbewahrung für Datenschutzaspekte.
- Der Assistent führt keine KI-Bereitstellung, automatischen Importe, Zeitpläne oder vollständigen Synchronisierungen aus. Diese werden später in den entsprechenden Admin-Tabs konfiguriert.
- Der Assistent ist kein Ersatz für ein Cookie-Consent-Tool, eine CMP, eine Datenschutzerklärung oder eine rechtliche Prüfung. Aktivieren Sie Analytics auf einer Live-Website erst, nachdem diese Anforderungen überprüft wurden.
Fehlerbehebung
- Der Willkommenshinweis erscheint nicht. Der Einrichtungsassistent wurde entweder abgeschlossen (
as24ci_setup_wizard_completed) oder übersprungen (as24ci_setup_wizard_skipped), dem aktuellen Benutzer fehlt die Berechtigung zur Verwaltung oder der Zeitstempel der Erstaktivierung wurde nicht aufgezeichnet (typisch für Upgrades, die keine Neuaktivierung ausgelöst haben). Öffnen Sie den Assistenten stattdessen überCar Market Hub → Tools → Setup Wizard. - Ich habe den Einrichtungsassistenten übersprungen. Wie öffne ich ihn wieder? Verwenden Sie den Link Setup Wizard ausführen auf
Car Market Hub → Dashboardoder die Karte Setup Wizard aufCar Market Hub → Tools. - Der Assistent hat meine Seiten nicht erstellt. Eine Seite mit demselben Titel existierte bereits und wurde wiederverwendet, oder die Option Überspringen wurde für diese Seite in Schritt 4 ausgewählt. Öffnen Sie
Pagesin WordPress und überprüfen Sie dies. Der Assistent löscht niemals Seiten. - Das Feld „Client Secret“ ist leer, wenn ich Schritt 3 erneut öffne. Dies ist beabsichtigt. Das gespeicherte Secret wird im Formular niemals wieder angezeigt. Wenn Sie das Feld leer lassen, bleibt der gespeicherte Wert erhalten.
- Analytics ist nach der Live-Einrichtung nicht aktiviert. Im Live-Modus ist der Analytics-Schalter ein Opt-in. Öffnen Sie den Assistenten erneut und aktivieren Sie ihn in Schritt 5, oder aktivieren Sie ihn auf dem Tab Analytics. Bestätigen Sie zuerst die Cookie-Einwilligung und die Datenschutzanforderungen.
- Demodaten wurden nicht installiert. Stellen Sie sicher, dass Sie in Schritt 1 Demo-Setup ausgewählt und in Schritt 6 auf Demodaten installieren und fertigstellen geklickt haben. Das Live-Setup installiert keine Demodaten.
- Vergleich oder Favoriten sind in der Demo leer. Vergleich und Favoriten basieren auf dem localStorage; die Demo stellt ein Fallback bereit, das den localStorage beim ersten Seitenaufruf befüllt. Öffnen Sie die Vergleichs- oder Favoritenseite einmal in derselben Browsersitzung, um die Befüllung auszulösen.
- Der Assistent überschreibt meine vorhandenen Einstellungen nicht. Richtig. Der Assistent schreibt nur Optionen, deren Formularfelder abgeschickt werden. Ein erneutes Ausführen des Assistenten löscht niemals unbeteiligte Einstellungen.