Core Architecture

What is the Core Architecture?

ComplyFlow is built on a modular, enterprise-grade architecture that ensures performance, extensibility, and security. Understanding the core structure helps users and site administrators make the most of the plugin and troubleshoot or extend it as needed.

Key Components

1. Main Plugin Class (Plugin.php)

1. Singleton Pattern: Only one instance of the plugin runs, preventing conflicts.
2. Hook Management: Centralizes all WordPress actions and filters for easy management.
3. Module Initialization: Loads and manages all feature modules (Consent, Accessibility, DSR, etc.).
4. Internationalization: Loads translation files for multi-language support.
5. REST API & WP-CLI: Registers custom REST API endpoints and WP-CLI commands for automation and integration.

2. Module Manager (ModuleManager.php)


6. Dynamic Module Registration: Enables or disables modules as needed.
7. Dependency Management: Ensures modules load in the correct order and with required dependencies.
8. Capability Checks: Only users with the right permissions can access or configure modules.
9. Versioning: Each module can be versioned and updated independently.

3. Loader (Loader.php)


10. Action/Filter Registration: Handles all WordPress hooks in a single place.
11. Priority Management: Controls the order in which hooks are executed.

4. Caching (Cache.php)


12. WordPress Transients: Stores temporary data for performance.
13. Object Caching: Supports Redis/Memcached for high-traffic sites.
14. Cache Groups: Organizes cache by type (settings, scans, consent, etc.).
15. TTL Management: Controls how long data is cached (15 min to 24 hours).
16. Cache Statistics: Tracks cache hits/misses for optimization.

5. Settings Repository (SettingsRepository.php)


17. Centralized Settings: All plugin settings are stored and retrieved from one place.
18. Validation/Sanitization: Ensures all settings are safe and valid.
19. Import/Export: Easily move settings between sites or environments.
20. Option Caching: Settings are cached for fast access.

6. Activator/Deactivator


21. Database Table Creation: Sets up all required tables on activation.
22. Default Settings: Initializes plugin with safe defaults.
23. Cleanup: Removes or resets data on deactivation.
24. Version Checks: Ensures compatibility with WordPress and PHP versions.

How It Benefits You


25. Performance: Optimized for speed and low resource usage.
26. Security: Follows WordPress best practices for data handling and permissions.
27. Extensibility: Easily add or remove features as your needs change.
28. Reliability: Modular design means one feature can be updated or fixed without affecting others.

Practical Tips


29. Use the settings import/export feature to quickly configure multiple sites.
30. If you experience issues, check the plugin’s cache and try flushing it from the Advanced settings tab.
31. Advanced users can use WP-CLI and REST API endpoints for automation and integration with other tools.

Related Documentation


32. See the Admin Settings and Advanced/Developer documentation for more on customizing and extending the plugin.