{"id":578,"date":"2025-02-14T17:06:16","date_gmt":"2025-02-14T17:06:16","guid":{"rendered":"https:\/\/divewp.com\/?page_id=578"},"modified":"2025-02-14T17:06:16","modified_gmt":"2025-02-14T17:06:16","slug":"documentation","status":"publish","type":"page","link":"https:\/\/divewp.com\/documentation\/","title":{"rendered":"Documentation"},"content":{"rendered":"
\r\n
\r\n
\r\n

diveWP Documentation<\/h1>\n

 <\/p>\n<\/div><\/div>\r\n\r\n

License and Copyright<\/h2>\n
    \n
  • License: GPL v2 or later<\/li>\n
  • License URI: http:\/\/www.gnu.org\/licenses\/gpl-2.0.html<\/li>\n
  • All code, including included libraries and assets, is GPL-compatible<\/li>\n<\/ul>\n

    Privacy and Data Collection<\/h2>\n

    DiveWP collects the following data locally<\/strong> on your server:<\/p>\n

      \n
    • Email logs (for email system monitoring)<\/li>\n
    • User events (for administrator activity tracking)<\/li>\n
    • Performance metrics<\/li>\n
    • Security scan results<\/li>\n<\/ul>\n

      Important:<\/strong> All data is stored locally in your WordPress database. No data is sent to external servers without explicit consent.<\/p>\n

      Code and Development<\/h2>\n
        \n
      • Source code is fully human-readable and documented<\/li>\n
      • Built using WordPress core libraries and functions<\/li>\n
      • No code obfuscation or hidden functionality<\/li>\n<\/ul>\n

        Installation and Setup<\/h2>\n

        Automatic Installation (Recommended)<\/h3>\n
          \n
        1. Upload the divewp<\/code> folder to \/wp-content\/plugins\/<\/code><\/li>\n
        2. Activate through WordPress admin panel<\/li>\n
        3. Access via 'DiveWP' in admin menu<\/li>\n<\/ol>\n

          Database Tables<\/h3>\n

          The plugin creates the following tables in your WordPress database:<\/p>\n

            \n
          1. {prefix}_divewp_email_log<\/code>: Tracks email communications<\/li>\n
          2. {prefix}_divewp_user_events<\/code>: Logs administrator activities<\/li>\n<\/ol>\n

            All tables use your WordPress database's charset and collation settings.<\/p>\n

            Third-Party Libraries and APIs<\/h3>\n

            This plugin uses:<\/p>\n

              \n
            • WordPress core libraries only<\/li>\n
            • No external services without user consent<\/li>\n
            • Standard WordPress hooks and filters<\/li>\n<\/ul>\n

              Security and Permissions<\/h3>\n
                \n
              • Requires 'manage_options' capability<\/li>\n
              • Implements WordPress security best practices<\/li>\n
              • Uses WordPress nonce verification<\/li>\n
              • Sanitizes all input\/output<\/li>\n<\/ul>\n

                File and Folder Structure<\/h2>\n
                \ndivewp\/\n\u251c\u2500\u2500 assets\/                        # Frontend and admin assets\n\u2502   \u251c\u2500\u2500 css\/                      # Stylesheet files\n\u2502   \u2502   \u251c\u2500\u2500 features\/            # Feature-specific styles\n\u2502   \u2502   \u2502   \u251c\u2500\u2500 dashboard.css    # Dashboard layout and components\n\u2502   \u2502   \u2502   \u251c\u2500\u2500 email-communications.css  # Email feature styles\n\u2502   \u2502   \u2502   \u251c\u2500\u2500 feedback.css    # User feedback interface\n\u2502   \u2502   \u2502   \u251c\u2500\u2500 timeline.css    # Timeline visualization\n\u2502   \u2502   \u2502   \u2514\u2500\u2500 user-events.css # User activity tracking styles\n\u2502   \u2502   \u251c\u2500\u2500 divewp-global.css   # Global plugin styles\n\u2502   \u2502   \u2514\u2500\u2500 style.css          # Main plugin stylesheet\n\u2502   \u251c\u2500\u2500 images\/                  # Plugin images and icons\n\u2502   \u2514\u2500\u2500 js\/                      # JavaScript files\n\u251c\u2500\u2500 content\/                      # Content and data files\n\u2502   \u251c\u2500\u2500 features\/               # Feature-specific content\n\u2502   \u2514\u2500\u2500 sidebar-content\/          # Sidebar widgets and content\n\u251c\u2500\u2500 includes\/                     # Core plugin PHP files\n\u2502   \u251c\u2500\u2500 admin\/                   # Admin interface components\n\u2502   \u251c\u2500\u2500 features\/                # Feature implementation classes\n\u2502   \u2514\u2500\u2500 templates\/               # Reusable template components\n\u251c\u2500\u2500 languages\/                    # Internationalization files\n\u251c\u2500\u2500 divewp.php                   # Main plugin file, bootstrap\n\u2514\u2500\u2500 uninstall.php               # Clean uninstallation handler\n<\/pre>\n
                Core Features<\/h2>\n
                1. Server Insights<\/h3>\n
                  \n
                • New server analysis system<\/li>\n
                • Performance monitoring<\/li>\n
                • Server configuration analysis<\/li>\n<\/ul>\n
                  2. Security Module<\/h3>\n
                    \n
                  • Security best practices implementation<\/li>\n
                  • Security headers management<\/li>\n
                  • XSS prevention<\/li>\n
                  • Path traversal prevention<\/li>\n<\/ul>\n
                    3. Email Communications<\/h3>\n
                      \n
                    • Email insights and analytics<\/li>\n
                    • Email logging system<\/li>\n
                    • Communication tracking<\/li>\n<\/ul>\n
                      4. Performance Optimization<\/h3>\n
                        \n
                      • Performance checks and monitoring<\/li>\n
                      • Timing data analysis<\/li>\n
                      • Optimization recommendations<\/li>\n<\/ul>\n
                        5. Database Management<\/h3>\n
                          \n
                        • Database insights<\/li>\n
                        • Table management<\/li>\n
                        • Performance optimization<\/li>\n
                        • Custom tables for:\n
                            \n
                          • Email logging<\/li>\n
                          • User events tracking<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
                            6. User Interface<\/h3>\n
                              \n
                            • Modern dashboard overview<\/li>\n
                            • Theme builder integration<\/li>\n
                            • Admin bar integration<\/li>\n
                            • Custom styling with Google Fonts integration<\/li>\n<\/ul>\n
                              7. Additional Features<\/h3>\n
                                \n
                              • WooCommerce best practices<\/li>\n
                              • SEO optimization<\/li>\n
                              • User event tracking<\/li>\n
                              • Feedback system<\/li>\n<\/ul>\n
                                Technical Requirements<\/h2>\n
                                Minimum Requirements<\/h3>\n
                                  \n
                                • WordPress 5.3.18 or higher<\/li>\n
                                • PHP 7.4 or higher<\/li>\n
                                • MySQL with InnoDB support<\/li>\n
                                • WordPress user with 'manage_options' capability<\/li>\n<\/ul>\n
                                  Features Overview<\/h2>\n
                                    \n
                                  • Dashboard Overview:<\/strong> Card-based visualization system<\/li>\n
                                  • Server Insights:<\/strong> PHP, MySQL, server configuration analysis<\/li>\n
                                  • Security Checks:<\/strong> SSL, file permissions, security best practices<\/li>\n
                                  • Performance Optimization:<\/strong> Caching, compression, speed factors<\/li>\n
                                  • Database Health:<\/strong> Size monitoring, optimization recommendations<\/li>\n
                                  • SEO Status:<\/strong> Sitemap, meta tags, search engine visibility<\/li>\n
                                  • Email System:<\/strong> SMTP configuration, delivery monitoring<\/li>\n
                                  • WooCommerce Integration:<\/strong> Performance analysis for stores<\/li>\n
                                  • Administrator Activity Tracking:<\/strong> Comprehensive user action logging<\/li>\n<\/ul>\n
                                    Architecture<\/h2>\n
                                      \n
                                    • Core Classes:<\/strong> Located in \/includes\/<\/code><\/li>\n
                                    • Feature Modules:<\/strong> Modular structure in \/includes\/features\/<\/code><\/li>\n
                                    • Admin Interface:<\/strong> Templates in \/includes\/admin\/templates\/<\/code><\/li>\n
                                    • Assets:<\/strong> CSS\/JS\/Images in \/assets\/<\/code><\/li>\n
                                    • Content:<\/strong> JSON-based content in \/content\/<\/code><\/li>\n<\/ul>\n
                                      Content Structure<\/h2>\n
                                        \n
                                      • JSON-based content system for maintainability<\/li>\n
                                      • Separate content from logic<\/li>\n
                                      • Easy to update without code changes<\/li>\n
                                      • Located in \/content\/features\/<\/code><\/li>\n<\/ul>\n
                                        Development Guide<\/h2>\n
                                          \n
                                        • Modular architecture for easy extensions<\/li>\n
                                        • WordPress coding standards compliance<\/li>\n
                                        • Action\/Filter hooks for customization<\/li>\n
                                        • Feature-specific classes in dedicated directories<\/li>\n<\/ul>\n
                                          Security<\/h2>\n
                                            \n
                                          • Enhanced security measures<\/li>\n
                                          • Input sanitization and validation<\/li>\n
                                          • Nonce verification<\/li>\n
                                          • Capability checks<\/li>\n
                                          • Secure data handling<\/li>\n<\/ul>\n
                                            Support and Updates<\/h2>\n
                                              \n
                                            • Regular updates via WordPress.org<\/li>\n
                                            • Support via WordPress.org forums<\/li>\n
                                            • Security updates prioritized<\/li>\n
                                            • Version numbering follows semantic versioning<\/li>\n<\/ul>\n
                                              Privacy Notice<\/h2>\n
                                              This plugin:<\/p>\n
                                                \n
                                              • Does not send data to external servers<\/li>\n
                                              • Stores all data in your WordPress database<\/li>\n
                                              • Requires user consent for any data collection<\/li>\n
                                              • Provides data export\/erasure tools<\/li>\n<\/ul>\n<\/div><\/div>\r\n<\/div>\r\n<\/div>\r\n\r\n
                                                \r\n
                                                \r\n
                                                Frequently Asked Questions<\/h2>\n
                                                \n
                                                <\/div>\n<\/div>\n<\/div><\/div>\r\n\r\n
                                                \r\n
                                                Do I need technical knowledge?<\/h5>
                                                Not at all! We explain everything in plain English and guide you through each step.<\/p>\n<\/div><\/div>\r\n\r\n
                                                Is WooCommerce required?<\/h5>
                                                No, but if you have WooCommerce installed, you'll get additional e-commerce specific insights.<\/p>\n<\/div><\/div>\r\n\r\n
                                                Will this modify my site settings?<\/h5>
                                                No, diveWP is a monitoring and learning tool. It provides insights and recommendations but doesn't make any changes to your site.<\/p>\n<\/div><\/div>\r\n\r\n
                                                Will this plugin slow down my site?<\/h5>
                                                No, diveWP runs only in the WordPress admin area and doesn't affect your front-end performance.<\/p>\n<\/div><\/div>\r\n<\/div>\r\n<\/div>\r\n<\/div>\r\n<\/div>","protected":false},"excerpt":{"rendered":"","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"inline_featured_image":false,"footnotes":""},"class_list":["post-578","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/divewp.com\/wp-json\/wp\/v2\/pages\/578","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/divewp.com\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/divewp.com\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/divewp.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/divewp.com\/wp-json\/wp\/v2\/comments?post=578"}],"version-history":[{"count":2,"href":"https:\/\/divewp.com\/wp-json\/wp\/v2\/pages\/578\/revisions"}],"predecessor-version":[{"id":580,"href":"https:\/\/divewp.com\/wp-json\/wp\/v2\/pages\/578\/revisions\/580"}],"wp:attachment":[{"href":"https:\/\/divewp.com\/wp-json\/wp\/v2\/media?parent=578"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}