ENTWICKLERDOKUMENTATION

Technische Entwicklerhinweise zur Integration von ADP Car Market Hub

Erkunden Sie die öffentliche Entwicklerdokumentation von ADP Car Market Hub mit Architektur, Hooks, Filtern, REST-API-Referenzen, AJAX-Aktionen, Cron-Hooks, Template-Overrides, Sicherheitsrichtlinien, Debugging und Release-Workflow.

Entwicklerdokumentation öffnen Hooks und Filter öffnen

Übersicht der Entwicklerdokumentation

Die Entwicklerdokumentation bietet technischen Implementierern einen strukturierten Einstieg in Plugin-Architektur, Erweiterungspunkte, Endpunkt-Verhalten und sichere Anpassungs-Workflows.

Architektur

Verstehen Sie Plugin-Struktur, Lebenszyklus, Datenmodell und technische Zuständigkeiten, bevor Sie erweitern oder integrieren.

Plugin-Architektur für Entwickler

Erweiterungspunkte

Verwenden Sie dokumentierte Actions, Filter, Hooks und Erweiterungspunkte, anstatt die Core-Dateien des Plugins zu bearbeiten.

Hooks und Filter

API und Hintergrundverarbeitung

Prüfen Sie REST-API-Verhalten, AJAX-Aktionen, Cron-Hooks und die Grenzen geplanter Verarbeitung.

REST-API für Entwickler

Templates und Frontend-Assets

Nutzen Sie Template-Overrides, Frontend-Assets und Shortcode-Verhalten, um die Ausgabe sicher anzupassen.

Template-System und Overrides

Sicherheits- und Release-Workflow

Beachten Sie vor dem Ausrollen von Änderungen Capability-Prüfungen, Sanitization, Escaping, Tests und Release-Vorgaben.

Sicherheits- und Capability-Prüfungen

Entwickler-Einstiegspunkte

Beginnen Sie mit den Dokumenten, die zu Ihrer Rolle und Implementierungsaufgabe passen.

Onboarding für neue Entwickler Erste Schritte
Entwickler-Übersicht Lokale Entwicklungsumgebung Repository-Struktur Coding-Standards
Plugin-Architektur Architektur
Plugin-Architektur für Entwickler Datenbanktabellen für Entwickler Option-Schlüssel und Speicherung der Einstellungen Custom Post Types und Taxonomien
Entwicklung von Erweiterungen Erweiterungspunkte
Hooks und Filter Actions-Referenz Filter-Referenz Erweiterungspunkte der Import-Engine
Frontend-Anpassung Frontend
Template-System und Overrides Frontend-Assets Admin-Assets Shortcodes für Entwickler

Architektur und Orientierung in der Codebasis

Bevor Integrationen oder Anpassungen hinzugefügt werden, sollten Entwickler den Plugin-Lebenszyklus, die Repository-Struktur, das Datenmodell und das Speicherverhalten verstehen.

Themen der Kernarchitektur

  • Plugin-Lebenszyklus
  • Repository-Struktur
  • Datenmodell
  • Datenbanktabellen
  • Speicherung von Optionen und Einstellungen
  • Custom Post Types und Taxonomien
  • Import-Engine
  • Bildimport-Warteschlange
  • Cron-Scheduler

Empfohlene Lesereihenfolge

Entwickler-Übersicht öffnen Plugin-Architektur öffnen Datenmodell öffnen

Erweiterungspunkte

Eigene Integrationen sollten dokumentierte Erweiterungspunkte verwenden und nicht die Core-Dateien des Plugins ändern.

Erweiterungsbereich Anwendungsfall Empfohlenes Dokument
Actions Auf Plugin-Ereignisse oder Verarbeitungsschritte reagieren Actions-Referenz
Filter Werte oder Ausgaben über kontrollierte Filterpunkte verändern Filter-Referenz
Übersicht zu Hooks und Filtern Die verfügbaren Erweiterungsmechanismen verstehen Hooks und Filter
Erweiterungspunkte der Import-Engine Importbezogenes Verhalten sicher erweitern oder anpassen Erweiterungspunkte der Import-Engine
Erweiterungspunkte des Bildimports Bildverarbeitung oder Warteschlangen-Verhalten anpassen, sofern unterstützt Erweiterungspunkte des Bildimports
Erweiterungspunkte der Lead-Verarbeitung Lead-Verarbeitung mit externen Workflows integrieren Erweiterungspunkte der Lead-Verarbeitung
Erweiterungspunkte des Analytics Analytics-bezogenes Verhalten erweitern, sofern unterstützt Erweiterungspunkte des Analytics
Erweiterungspunkte für Market Insights Grenzen der Erweiterung für marktbezogene Logik prüfen Erweiterungspunkte für Market Insights
Erweiterungspunkte des PDF-Managers PDF-bezogene Workflows erweitern oder anpassen, sofern unterstützt Erweiterungspunkte des PDF-Managers

API, AJAX und Hintergrundverarbeitung

Entwickler sollten das Endpunkt-Verhalten, AJAX-Aktionen und Cron-Hooks prüfen, bevor sie technische Workflows erweitern.

Templates und Frontend-Assets

Die Frontend-Anpassung sollte das dokumentierte Template-System, das Shortcode-Verhalten und die Asset-Struktur verwenden.

Template-System

  • Template-Overrides
  • Archiv-Ausgabe
  • Fahrzeugdetail-Ausgabe
  • Shortcodes
  • Frontend-Module
  • Theme-Kompatibilität
Template-System und Overrides Template-Overrides Shortcodes für Entwickler Frontend-Leitfaden

Assets und UI-Verhalten

  • Frontend-Assets
  • Admin-Assets
  • Responsives Verhalten
  • Page-Builder-Integration
  • Individuelles CSS
  • Einschränkungen der Admin-Oberfläche
Frontend-Assets Admin-Assets Leitfaden für individuelles CSS Page-Builder-Integration

Sicherheit, Sanitization und Capability-Prüfungen

Entwicklerarbeit muss den WordPress-Sicherheitspraktiken folgen und das Offenlegen privater Daten oder unsichere Operationen vermeiden.

Erforderliche Praktiken

  • Capability-Prüfungen für privilegierte Aktionen verwenden
  • Nonces für AJAX- und Formularaktionen validieren
  • Eingehende Daten bereinigen
  • Ausgaben escapen
  • Keine Zugangsdaten offenlegen
  • Keine sensiblen Werte loggen
  • Vorbereitete Datenbankabfragen verwenden
  • Datenschutz- und Aufbewahrungseinstellungen respektieren

Entwicklerreferenzen

Sicherheits- und Capability-Prüfungen Sanitization und Escaping Zugriffskontrolle und Capabilities Datenschutz, Sicherheit und Compliance Bekannte Einschränkungen und offene Risiken

Debugging-, Test- und Release-Workflow

Vor dem Ausrollen von Änderungen sollten Entwickler die Dokumentation zu Logging, Debugging, Tests und Release-Workflow prüfen.

  1. Lokal debuggen Nutzen Sie lokale Entwicklung und Logging-Hinweise, um Probleme zu reproduzieren, bevor das Produktivverhalten geändert wird.
    Lokale Entwicklungsumgebung Logging und Debugging
  2. Verhalten validieren Testen Sie Import-Workflows, API-Antworten, Cron-Hooks, Frontend-Ausgaben und Admin-Bildschirme nach Änderungen.
    Testleitfaden Erweiterungspunkte der Import-Engine
  3. Sicherheit prüfen Prüfen Sie vor dem Release Sanitization, Escaping, Capabilities und die Offenlegung öffentlicher Daten.
    Sicherheits- und Capability-Prüfungen Sanitization und Escaping
  4. Release vorbereiten Befolgen Sie die Release-, Build- und Beitragshinweise, bevor Sie Änderungen paketieren oder ausrollen.
    Release- und Build-Prozess Beitragshinweise

Regeln der öffentlichen Entwicklerdokumentation

Die Entwicklerdokumentation soll für Implementierungspartner nützlich sein, ohne private Implementierungsdetails offenzulegen.

Veröffentlichungsfähig

  • Architektur-Übersichten
  • Öffentliche Hooks und Filter
  • Allgemeines Endpunkt-Verhalten
  • Hinweise zu Template-Overrides
  • Coding-Standards
  • Test-Workflow
  • Troubleshooting-Hinweise
  • Release-Prozess
  • Allgemeine Erweiterungspunkte

Nicht veröffentlichen

  • API-Secrets
  • Private Access-Tokens
  • Interne Server-Pfade
  • Kundendaten
  • Private API-URLs
  • Rohe Zugangsdaten
  • Sicherheitsrelevante Exploit-Details
  • Vertrauliche Implementierungsnotizen
  • Interne Risikohinweise

Entwicklerdokumentation

Öffnen Sie die relevanten Entwicklerdokumente direkt im öffentlichen Dokumentations-Repository.

Erste Schritte für Entwickler

Architektur und Speicherung

Erweiterungspunkte

API und Hintergrundverarbeitung

Sicherheit, Debugging und Release

Die Dokumentationslinks folgen der aktiven Website-Sprache. Englisch ist die Quellsprache. Weitere Sprachordner verwenden lokalisierte Ordner- und Dateinamen.

Weiter erkunden

API und Webhooks öffnen Integrationsleitfaden öffnen Systemanforderungen öffnen