diveWP Documentation

 

License and Copyright

  • License: GPL v2 or later
  • License URI: http://www.gnu.org/licenses/gpl-2.0.html
  • All code, including included libraries and assets, is GPL-compatible

Privacy and Data Collection

DiveWP collects the following data locally on your server:

  • Email logs (for email system monitoring)
  • User events (for administrator activity tracking)
  • Performance metrics
  • Security scan results

Important: All data is stored locally in your WordPress database. No data is sent to external servers without explicit consent.

Code and Development

  • Source code is fully human-readable and documented
  • Built using WordPress core libraries and functions
  • No code obfuscation or hidden functionality

Installation and Setup

Automatic Installation (Recommended)

  1. Upload the divewp folder to /wp-content/plugins/
  2. Activate through WordPress admin panel
  3. Access via ‘DiveWP’ in admin menu

Database Tables

The plugin creates the following tables in your WordPress database:

  1. {prefix}_divewp_email_log: Tracks email communications
  2. {prefix}_divewp_user_events: Logs administrator activities

All tables use your WordPress database’s charset and collation settings.

Third-Party Libraries and APIs

This plugin uses:

  • WordPress core libraries only
  • No external services without user consent
  • Standard WordPress hooks and filters

Security and Permissions

  • Requires ‘manage_options’ capability
  • Implements WordPress security best practices
  • Uses WordPress nonce verification
  • Sanitizes all input/output

File and Folder Structure

divewp/
├── assets/                        # Frontend and admin assets
│   ├── css/                      # Stylesheet files
│   │   ├── features/            # Feature-specific styles
│   │   │   ├── dashboard.css    # Dashboard layout and components
│   │   │   ├── email-communications.css  # Email feature styles
│   │   │   ├── feedback.css    # User feedback interface
│   │   │   ├── timeline.css    # Timeline visualization
│   │   │   └── user-events.css # User activity tracking styles
│   │   ├── divewp-global.css   # Global plugin styles
│   │   └── style.css          # Main plugin stylesheet
│   ├── images/                  # Plugin images and icons
│   └── js/                      # JavaScript files
├── content/                      # Content and data files
│   ├── features/               # Feature-specific content
│   └── sidebar-content/          # Sidebar widgets and content
├── includes/                     # Core plugin PHP files
│   ├── admin/                   # Admin interface components
│   ├── features/                # Feature implementation classes
│   └── templates/               # Reusable template components
├── languages/                    # Internationalization files
├── divewp.php                   # Main plugin file, bootstrap
└── uninstall.php               # Clean uninstallation handler

Core Features

1. Server Insights

  • New server analysis system
  • Performance monitoring
  • Server configuration analysis

2. Security Module

  • Security best practices implementation
  • Security headers management
  • XSS prevention
  • Path traversal prevention

3. Email Communications

  • Email insights and analytics
  • Email logging system
  • Communication tracking

4. Performance Optimization

  • Performance checks and monitoring
  • Timing data analysis
  • Optimization recommendations

5. Database Management

  • Database insights
  • Table management
  • Performance optimization
  • Custom tables for:
    • Email logging
    • User events tracking

6. User Interface

  • Modern dashboard overview
  • Theme builder integration
  • Admin bar integration
  • Custom styling with Google Fonts integration

7. Additional Features

  • WooCommerce best practices
  • SEO optimization
  • User event tracking
  • Feedback system

Technical Requirements

Minimum Requirements

  • WordPress 5.3.18 or higher
  • PHP 7.4 or higher
  • MySQL with InnoDB support
  • WordPress user with ‘manage_options’ capability

Features Overview

  • Dashboard Overview: Card-based visualization system
  • Server Insights: PHP, MySQL, server configuration analysis
  • Security Checks: SSL, file permissions, security best practices
  • Performance Optimization: Caching, compression, speed factors
  • Database Health: Size monitoring, optimization recommendations
  • SEO Status: Sitemap, meta tags, search engine visibility
  • Email System: SMTP configuration, delivery monitoring
  • WooCommerce Integration: Performance analysis for stores
  • Administrator Activity Tracking: Comprehensive user action logging

Architecture

  • Core Classes: Located in /includes/
  • Feature Modules: Modular structure in /includes/features/
  • Admin Interface: Templates in /includes/admin/templates/
  • Assets: CSS/JS/Images in /assets/
  • Content: JSON-based content in /content/

Content Structure

  • JSON-based content system for maintainability
  • Separate content from logic
  • Easy to update without code changes
  • Located in /content/features/

Development Guide

  • Modular architecture for easy extensions
  • WordPress coding standards compliance
  • Action/Filter hooks for customization
  • Feature-specific classes in dedicated directories

Security

  • Enhanced security measures
  • Input sanitization and validation
  • Nonce verification
  • Capability checks
  • Secure data handling

Support and Updates

  • Regular updates via WordPress.org
  • Support via WordPress.org forums
  • Security updates prioritized
  • Version numbering follows semantic versioning

Privacy Notice

This plugin:

  • Does not send data to external servers
  • Stores all data in your WordPress database
  • Requires user consent for any data collection
  • Provides data export/erasure tools

Frequently Asked Questions

Do I need technical knowledge?

Not at all! We explain everything in plain English and guide you through each step.

Is WooCommerce required?

No, but if you have WooCommerce installed, you’ll get additional e-commerce specific insights.

Will this modify my site settings?

No, diveWP is a monitoring and learning tool. It provides insights and recommendations but doesn’t make any changes to your site.

Will this plugin slow down my site?

No, diveWP runs only in the WordPress admin area and doesn’t affect your front-end performance.