How prathushan/wp-site-inspector-agent works
Project Type & Purpose
• This is a WordPress plugin (monolithic codebase) that plugs into the WP Admin area.
• Purpose: scan themes/plugins, surface hooks/shortcodes/REST endpoints, detect/fix errors via AI, export reports.
Main Components
A. WordPress Core
• Hook registration, menu pages, REST API.
• Database (MySQL) for post types, plugin/theme data.
B. WP Site Inspector Plugin
1. Entry Point (wp-site-inspector.php)
– Registers admin menu, enqueues scripts/styles, hooks into AJAX.
2. Admin UI Module (admin/class-admin-ui.php + admin/views/*.php)
– Renders dashboard, scan forms, chatbot widget.
3. Analyzer Module (admin/class-analyzer.php)
– Uses WP filesystem APIs to crawl theme/plugin files, detect hooks/shortcodes.
4. Backup & Export Module (admin/class-backup-export.php, includes/class-export-handler.php)
– Takes .bak snapshots, exports .xls using PHPExcel (in assets/libs).
5. Fix Agent Module (admin/class-fix-agent.php)
– Parses error logs, calls external AI API, writes fixes, restores backups.
6. Settings Module (admin/class-settings.php)
– Manages BYOK (Bring Your Own Key) configuration and provider/model selection.
7. Includes / Utility Handlers (includes/…)
– AJAX handlers, email alerts (class-email-handler.php), logging, helper functions.
8. Assets (admin/assets/, assets/libs/)
– JS/CSS for interactive UI, third-party libraries for file export.
9. Languages (languages/*.po/.mo)
– i18n support for EN, DE, ES.
C. External Services
– AI Providers (OpenAI, Anthropic, Google Gemini, DeepSeek, OpenRouter, WPSI-01).
– Email SMTP (for fatal error alerts).
Relationships & Data Flows
• Admin Browser ↔ WP Core
• Admin logs in, clicks “Site Inspector” menu.
• WP Core loads plugin’s admin UI.
• UI ↔ AJAX Handlers
• JS sends scan or chat/fix requests to admin-ajax.php.
• AJAX Handlers → Plugin Modules
• Handler routes requests to Analyzer or Fix Agent.
• Analyzer reads filesystem, WP DB, returns JSON.
• Fix Agent calls AI API, writes files, manages backups.
• Plugin Modules ↔ External AI API
• HTTP requests (REST) with user’s API key.
• Plugin Modules ↔ Database
• Reads post types, options (settings), logs scan/fix events (logger).
• Export Module → File System
• Creates .xls, saves to wp-content/uploads or streams download.
• Error Handling
• Logger writes to WP Debug log.
• Email Handler sends alerts.
Architectural Patterns & Principles
• Modular PHP classes per concern (Single Responsibility).
• WordPress Hook + AJAX-driven micro-endpoints.
• Backup-before-modify strategy for safe auto-fix.
• BYOK design for pluggable AI providers.
• MVC-like separation: Views (admin/views), Controllers (ajax-handlers), Models (filesystem + DB operations in classes).
Final Checklist
• [ ] Clear, named containers for WP Core vs Plugin.
• [ ] All plugin components (Admin UI, Analyzer, Fix Agent, Export, Settings, AJAX Handlers, Email, Logger).
• [ ] Database and File Storage nodes.
• [ ] External AI service providers.