# devkabir/wp-debugger architecture

> Architecture diagram of the GitHub repository devkabir/wp-debugger, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/devkabir/wp-debugger
- Repository: https://github.com/devkabir/wp-debugger

## Overview

##### Project type and purpose
- This is a WordPress plugin (“WordPress Debugger”) whose goal is to hook into the WP lifecycle, collect debug information (via the Debug Bar), render custom error pages when exceptions occur, and provide a templated front-end for debugging output.

##### File structure
- Top-level files:
- plugin.php – main WP plugin bootstrap (registers hooks, enqueues assets)
- autoload.php – PSR-4 autoloader for the src/ classes
- functions.php – utility functions used by multiple classes
- readme.md – plugin description for the repo/WordPress directory
- src/ contains the main PHP classes (DebugBar, ErrorPage, HTTP, Log, Plugin, Template).
- Build config files in assets/ (package.json, PostCSS, Tailwind configs) support a local NPM‐based asset pipeline.

##### README for additional insights
- Confirms this is a WP plugin, installs via the WP plugin directory, and supports PHP 7.1+.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External WordPress Environment
    WP["WordPress Core\n(hooks & loader)"]:::external

    %% Plugin Core
    subgraph "Plugin Core (PHP Modules)"
        direction TB
        Autoloader["autoload.php"]:::server
        click Autoloader "https://github.com/devkabir/wp-debugger/blob/main/autoload.php"
        Utils["functions.php"]:::server
        click Utils "https://github.com/devkabir/wp-debugger/blob/main/functions.php"
        PluginBootstrap["plugin.php"]:::server
        click PluginBootstrap "https://github.com/devkabir/wp-debugger/blob/main/plugin.php"
        PluginClass["src/class-plugin.php"]:::server
        click PluginClass "https://github.com/devkabir/wp-debugger/blob/main/src/class-plugin.php"
        HTTP["HTTP Module\nclass-http.php"]:::server
        click HTTP "https://github.com/devkabir/wp-debugger/blob/main/src/class-http.php"
        LogMod["Log Module\nclass-log.php"]:::server
        click LogMod "https://github.com/devkabir/wp-debugger/blob/main/src/class-log.php"
        DebugBar["Debug Bar Module\nclass-debug-bar.php"]:::server
        click DebugBar "https://github.com/devkabir/wp-debugger/blob/main/src/class-debug-bar.php"
        ErrorPage["Error Page Module\nclass-error-page.php"]:::server
        click ErrorPage "https://github.com/devkabir/wp-debugger/blob/main/src/class-error-page.php"
        Template["Template Engine\nclass-template.php"]:::server
        click Template "https://github.com/devkabir/wp-debugger/blob/main/src/class-template.php"
    end

    %% Templates Sub-components
    subgraph "Templates"
        direction TB
        subgraph "Bar Templates"
            BarHTML1["bar.html"]:::client
            click BarHTML1 "https://github.com/devkabir/wp-debugger/blob/main/assets/templates/bar/bar.html"
            BarHTML2["item.html"]:::client
            click BarHTML2 "https://github.com/devkabir/wp-debugger/blob/main/assets/templates/bar/item.html"
            BarHTML3["table.html"]:::client
            click BarHTML3 "https://github.com/devkabir/wp-debugger/blob/main/assets/templates/bar/table.html"
            BarHTML4["table_row.html"]:::client
            click BarHTML4 "https://github.com/devkabir/wp-debugger/blob/main/assets/templates/bar/table_row.html"
            BarHTML5["with-icon.html"]:::client
            click BarHTML5 "https://github.com/devkabir/wp-debugger/blob/main/assets/templates/bar/with-icon.html"
            BarCSS["bar.css"]:::client
            click BarCSS "https://github.com/devkabir/wp-debugger/blob/main/assets/css/bar.css"
        end
        subgraph "Page Templates"
            PageHTML1["layout.html"]:::client
            click PageHTML1 "https://github.com/devkabir/wp-debugger/blob/main/assets/templates/page/layout.html"
            PageHTML2["exception.html"]:::client
            click PageHTML2 "https://github.com/devkabir/wp-debugger/blob/main/assets/templates/page/exception.html"
            PageHTML3["code.html"]:::client
            click PageHTML3 "https://github.com/devkabir/wp-debugger/blob/main/assets/templates/page/code.html"
            PageHTML4["dump.html"]:::client
            click PageHTML4 "https://github.com/devkabir/wp-debugger/blob/main/assets/templates/page/dump.html"
            PageHTML5["variable.html"]:::client
            click PageHTML5 "https://github.com/devkabir/wp-debugger/blob/main/assets/templates/page/variable.html"
            PageCSS["page.css"]:::client
            click PageCSS "https://github.com/devkabir/wp-debugger/blob/main/assets/css/page.css"
        end
    end

    %% Asset Pipeline
    subgraph "Asset Pipeline (Build Tools)"
        direction TB
        PackageJSON["package.json"]:::build
        click PackageJSON "https://github.com/devkabir/wp-debugger/blob/main/assets/package.json"
        PackageLock["package-lock.json"]:::build
        click PackageLock "https://github.com/devkabir/wp-debugger/blob/main/assets/package-lock.json"
        PostCSS["postcss.config.js"]:::build
        click PostCSS "https://github.com/devkabir/wp-debugger/blob/main/assets/postcss.config.js"
        TailwindBar["tailwind.bar.config.js"]:::build
        click TailwindBar "https://github.com/devkabir/wp-debugger/blob/main/assets/tailwind.bar.config.js"
        TailwindPage["tailwind.page.config.js"]:::build
        click TailwindPage "https://github.com/devkabir/wp-debugger/blob/main/assets/tailwind.page.config.js"
    end

    %% Front-end Assets & Browser
    subgraph "Client (Browser & Static Assets)"
        direction TB
        PrismCSS["prism.css"]:::client
        click PrismCSS "https://github.com/devkabir/wp-debugger/blob/main/assets/css/prism.css"
        PrismJS["prism.js"]:::client
        click PrismJS "https://github.com/devkabir/wp-debugger/blob/main/assets/js/prism.js"
        Icons["assets/icons/*"]:::client
        click Icons "https://github.com/devkabir/wp-debugger/tree/main/assets/icons/"
        Browser["Browser\n(displays debug bar or error page)"]:::external
    end

    %% Project Metadata
    subgraph "Metadata & Config"
        direction TB
        Readme["readme.md"]:::meta
        click Readme "https://github.com/devkabir/wp-debugger/blob/main/readme.md"
        EditorConfig[".editorconfig"]:::meta
        click EditorConfig "https://github.com/devkabir/wp-debugger/blob/main/.editorconfig"
        Gitignore[".gitignore"]:::meta
        click Gitignore "https://github.com/devkabir/wp-debugger/blob/main/.gitignore"
        PHPCS[".phpcs.xml"]:::meta
        click PHPCS "https://github.com/devkabir/wp-debugger/blob/main/.phpcs.xml"
    end

    %% Relationships
    WP -->|"activation/init hooks"| PluginBootstrap
    PluginBootstrap -->|register hooks| PluginClass
    PluginClass --> Autoloader
    PluginClass --> Utils
    PluginClass --> HTTP
    PluginClass --> LogMod
    PluginClass --> DebugBar
    PluginClass --> ErrorPage
    PluginClass --> Template

    HTTP -->|collects request data| LogMod
    LogMod --> DebugBar
    LogMod --> ErrorPage

    DebugBar -->|uses templates| BarHTML1
    DebugBar --> BarHTML2
    DebugBar --> BarHTML3
    DebugBar --> BarHTML4
    DebugBar --> BarHTML5
    DebugBar --> BarCSS

    ErrorPage -->|uses templates| PageHTML1
    ErrorPage --> PageHTML2
    ErrorPage --> PageHTML3
    ErrorPage --> PageHTML4
    ErrorPage --> PageHTML5
    ErrorPage --> PageCSS

    Template -->|loads templates| BarHTML1
    Template --> PageHTML1

    PackageJSON -->|build assets| BarCSS
    PackageJSON --> PageCSS
    PostCSS --> BarCSS
    TailwindBar --> BarCSS
    TailwindPage --> PageCSS

    PluginBootstrap -->|enqueues assets| BarCSS
    PluginBootstrap --> PageCSS
    PluginBootstrap --> PrismCSS
    PluginBootstrap --> PrismJS
    PluginBootstrap --> Icons

    Browser -->|renders| BarCSS
    Browser --> PrismJS
    Browser -->|"shows debug UI"| DebugBar
    Browser -->|"shows error page"| ErrorPage

    %% Styles
    classDef external fill:#f9f,stroke:#333,stroke-width:1px
    classDef server fill:#bbf,stroke:#333,stroke-width:1px
    classDef client fill:#bfb,stroke:#333,stroke-width:1px
    classDef build fill:#ffb,stroke:#333,stroke-width:1px
    classDef meta fill:#ddd,stroke:#333,stroke-width:1px
```
