Documentation · Documentation technique

Documentation technique

Ce document est le point d'entrée de la documentation technique du plugin ADP Car Market Hub WordPress. Il explique ce que couvre la section technique, à qui elle s'adresse et comment les différents documents s'articulent entre eux.

Quand utiliser ce document

Lisez ce document si vous êtes :

  • Un développeur qui a besoin de comprendre comment le plugin est structuré avant de personnaliser les modèles, les hooks ou les intégrations.
  • Un administrateur de site qui souhaite savoir quels événements planifiés, options et tables de base de données le plugin utilise sur une installation WordPress.
  • Un intégrateur qui doit planifier un déploiement, un examen d'environnement ou un audit de sécurité du plugin.

Les utilisateurs finaux qui souhaitent uniquement gérer les annonces de véhicules, les leads ou les options de design doivent plutôt commencer par les sections de la documentation destinées aux utilisateurs.

Aperçu

ADP Car Market Hub est un plugin WordPress qui importe des annonces de véhicules depuis l'API AutoScout24 et les publie sur un site WordPress. Le plugin est implémenté en PHP à l'aide des API de base de WordPress (custom post types, taxonomies, options, WP-Cron, REST API, AJAX, transients et tables personnalisées gérées par dbDelta).

La documentation technique décrit :

  • L'architecture de haut niveau et les responsabilités des principales classes PHP sous includes/.
  • La séquence d'initialisation (bootstrap), ainsi que les flux d'activation, de désactivation et de désinstallation.
  • Le modèle de données qui sous-tend les véhicules, les leads et les fonctionnalités destinées aux visiteurs telles que les alertes de recherche et l'analyse.
  • Les tables de base de données personnalisées créées via dbDelta et les clés postmeta qui restent dans wp_postmeta pour des raisons de compatibilité ascendante.
  • Les surfaces d'intégration (points de terminaison REST, actions AJAX, webhooks, shortcodes, surcharges de modèles) sur lesquelles d'autres codes peuvent s'appuyer.

Les documents de cette section sont des documents de référence. Ils décrivent le comportement visible dans le code source du plugin au moment de la rédaction. Vérifiez le comportement par rapport à la version actuelle du plugin avant de vous y fier pour un travail en production.

Configuration requise ou prérequis

Avant de lire les documents techniques, vous devez disposer de :

  • Un environnement de développement WordPress fonctionnel qui répond aux exigences déclarées du plugin : WordPress 6.2 ou plus récent et PHP 8.1 ou plus récent (voir l'en-tête du plugin dans adp-car-market-hub.php et readme.txt).
  • Une compréhension générale du développement de plugins WordPress (hooks, custom post types, API des options, WP-Cron et API REST).
  • Une familiarité de base avec la couche de base de données WordPress ($wpdb, dbDelta, postmeta et transients).
  • Un accès à l'arborescence des sources du plugin si vous souhaitez croiser les classes et les constantes mentionnées dans la documentation.

Aucun compte externe n'est requis pour lire la documentation. Pour tester les fonctionnalités d'importation en pratique, vous devez également disposer d'identifiants API AutoScout24 valides et d'au moins un vendeur configuré. La configuration de ces identifiants est traitée dans la documentation de configuration destinée aux utilisateurs.

Comment cette section est organisée

La documentation technique est divisée en documents ciblés. Les points d'entrée les plus importants sont listés ci-dessous ; reportez-vous à l'index de la section pour la liste complète.

  1. Aperçu de l'architecture — carte de haut niveau des principales classes, des espaces de noms et de la manière dont les fonctionnalités sont reliées entre elles au moment de l'exécution.
  2. Initialisation et cycle de vie du plugin — ordre d'exécution depuis le chargement du plugin jusqu'à l'activation, le traitement normal des requêtes et la désactivation.
  3. Modèle de données — entités logiques (véhicules, leads, agents de recherche, événements d'analyse) et leur correspondance avec le stockage WordPress.
  4. Schéma de la base de données — les tables personnalisées gérées par dbDelta créées par le plugin, y compris les colonnes et les index.

Les documents suivants détaillent des sous-systèmes spécifiques tels que l'importateur, la file d'attente d'images, l'API REST, les actions AJAX et le système de modèles.

Conventions utilisées dans cette section

  • Les noms de classes sont écrits sous leur forme complète en utilisant l'espace de noms AS24CI\ (par exemple AS24CI\Plugin, AS24CI\Vehicle_Repository).
  • Les clés d'options sont citées sous forme de chaînes de caractères (par exemple as24ci_db_version) et, le cas échéant, la constante AS24CI\Options qui les définit est référencée.
  • Les tables de base de données sont écrites sans le préfixe de table WordPress (par exemple as24_vehicles) ; le nom réel de la table sur un site donné est {$wpdb->prefix} suivi du suffixe.
  • Les hooks sont référencés par leur étiquette d'action ou de filtre (par exemple as24ci_scheduled_import).

Lorsqu'un comportement est configurable, la documentation indique l'option, le filtre ou la constante qui le contrôle. Lorsque quelque chose ne peut pas être confirmé à partir du code source, la documentation le mentionne explicitement. Vérifiez tout cas particulier dans la version actuelle du plugin avant de publier des conseils clients basés sur celui-ci.

Notes opérationnelles

  • La documentation technique ne contient pas d'identifiants, de données clients, d'URL internes, de Seller ID ou d'autres valeurs confidentielles. Les exemples de valeurs présentés dans les extraits de code sont tirés directement de la source du plugin et ne sont donnés qu'à titre illustratif.
  • Le plugin utilise un autoloader de style PSR-4 enregistré dans adp-car-market-hub.php. Les classes sous l'espace de noms AS24CI\ sont chargées à la demande depuis includes/ et includes/admin/. Ceci est important lors de l'ajout d'intégrations personnalisées qui dépendent des classes du plugin.
  • Toutes les chaînes traduisibles du plugin utilisent le domaine de texte adp-car-market-hub. La documentation technique elle-même est uniquement en anglais.

Dépannage

Ce document d'introduction ne décrit pas de pannes spécifiques. Si vous étudiez un problème, commencez par le document qui couvre le sous-système concerné (par exemple Événements Cron et planificateur pour les problèmes de planification d'importation, ou Schéma de la base de données pour les erreurs liées aux tables). Chaque document de sous-système comprend ses propres notes de dépannage, le cas échéant.

Documents connexes