# terrylinooo/airy-seo architecture

> Architecture diagram of the GitHub repository terrylinooo/airy-seo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/terrylinooo/airy-seo
- Repository: https://github.com/terrylinooo/airy-seo

## Overview

##### Project Purpose and Type
- This is an open‐source WordPress plugin whose primary goal is to inject SEO‐related meta tags (general, Facebook OpenGraph, Twitter Card) into a site’s pages and provide an admin UI for configuration.

##### Break Down the File Structure into Logical Components
- Plugin Bootstrap & Core
- airy‑seo.php (plugin header, WP hook registrations)
- airyseo/Launcher.php (initializes modules & admin classes)
- airyseo/Enums.php (constants/enums used throughout)
- Modules (Feature Plugins)
- airyseo/Modules/MetaTags.php
- airyseo/Modules/FacebookOpenGraph.php
- airyseo/Modules/TwitterCard.php
- Admin UI
- airyseo/Admin/*.php (Activation, Menu, Settings, Metabox, Posts)
- views/admin/… (options pages & metabox templates)
- Assets
- assets/css/style.css
- assets/js/metabox.js
- Views (Front‑end & Admin)
- views/modules/*.php (output for front‑end)
- views/admin/parts/*.php (UI partials)
- Persistence & Integration
- WordPress Core (hooks, options API, postmeta, screens)
- Database (wp_options for settings; wp_postmeta for per‑post SEO overrides)
- Third‐Party/Dependencies
- vendor/ (composer dependencies, if any)

##### Relationships & Data Flows
- At plugin load: WP calls airy‑seo.php → Launcher registers hooks:
- front­end hooks (wp_head) → modules generate meta tags → views/modules/*.php
- admin_init & admin_menu hooks → Admin classes build menu, register settings → settings pages (views/admin/options/*.php)
- add_meta_boxes hook → Metabox module injects per‑post UI (views/admin/metabox.php)
- Settings saved via WP Options API → Modules read settings when rendering tags
- Uninstall hook (uninstall.php) cleans up options/postmeta

##### Architectural Patterns & Principles
- Modular design: each SEO feature lives in its own Module class
- MVC‑like separation for Admin: Admin classes (controllers) + views/templates (V) + WP options (model)
- Single responsibility: Launcher, Enums, Activation, Settings, Metabox each have discrete roles
- Use of hooks & filters (inversion of control) to integrate cleanly into WP

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Core
    WP["WordPress Core"]:::core

    %% Plugin Bootstrap
    subgraph "Plugin Bootstrap"
        PH["airy-seo.php"]:::internal
        LN["Launcher\n(airyseo/Launcher.php)"]:::internal
        EN["Enums\n(airyseo/Enums.php)"]:::internal
    end

    %% Dependencies
    subgraph "Third-Party Dependencies"
        VND["vendor/"]:::internal
    end

    %% Module Layer
    subgraph "Module Layer"
        MT["MetaTags\n(airyseo/Modules/MetaTags.php)"]:::internal
        FG["FacebookOpenGraph\n(airyseo/Modules/FacebookOpenGraph.php)"]:::internal
        TC["TwitterCard\n(airyseo/Modules/TwitterCard.php)"]:::internal
        FView["facebook-open-graph.php\n(views/modules/facebook-open-graph.php)"]:::internal
        TView["twitter-card.php\n(views/modules/twitter-card.php)"]:::internal
    end

    %% Admin Layer
    subgraph "Admin Layer"
        AC["Activation\n(airyseo/Admin/Activation.php)"]:::internal
        MN["Menu\n(airyseo/Admin/Menu.php)"]:::internal
        ST["Settings\n(airyseo/Admin/Settings.php)"]:::internal
        MB["Metabox\n(airyseo/Admin/Metabox.php)"]:::internal
        PS["Posts\n(airyseo/Admin/Posts.php)"]:::internal
        AS["Assets\n(airyseo/Admin/Assets.php)"]:::internal
        AO1["facebook-open-graph.php\n(views/admin/options/facebook-open-graph.php)"]:::internal
        AO2["twitter-card.php\n(views/admin/options/twitter-card.php)"]:::internal
        AO3["options.php\n(views/admin/options.php)"]:::internal
        MBV["metabox.php\n(views/admin/metabox.php)"]:::internal
        PP["seo-column.php\n(views/admin/parts/seo-column.php)"]:::internal
    end

    %% Asset Server
    subgraph "Asset Server"
        CSS["style.css"]:::internal
        JS["metabox.js"]:::internal
    end

    %% Database
    DB["Database\n(wp_options & wp_postmeta)"]:::database

    %% Uninstall
    UN["uninstall.php"]:::internal

    %% External
    subgraph "External Consumers"
        FB["Facebook"]:::external
        TW["Twitter"]:::external
    end

    %% Connections
    WP -->|initializes| PH
    PH -->|loads| LN
    PH -->|includes| EN
    PH -->|loads deps| VND

    LN -->|registers hook: wp_head| MT
    LN -->|registers hook: wp_head| FG
    LN -->|registers hook: wp_head| TC
    LN -->|registers hook: admin_init| MN
    LN -->|registers hook: admin_init| ST
    LN -->|registers hook: admin_init| AC
    LN -->|registers hook: add_meta_boxes| MB

    MT -->|uses view| FView
    FG -->|uses view| FView
    TC -->|uses view| TView

    MN -->|loads view| AO1
    MN -->|loads view| AO2
    MN -->|loads view| AO3
    MB -->|loads view| MBV
    MB -->|loads view| PP

    AS -->|enqueues| CSS
    AS -->|enqueues| JS

    ST -->|reads/writes| DB
    MB -->|reads/writes| DB
    PS -->|reads/writes| DB

    MT -->|renders meta tags| WP
    FG -->|renders meta tags| WP
    TC -->|renders meta tags| WP

    WP -->|serves tags to| FB
    WP -->|serves tags to| TW

    WP -->|on uninstall| UN
    UN -->|cleans| DB

    %% Click Events
    click PH "https://github.com/terrylinooo/airy-seo/blob/master/airy-seo.php"
    click LN "https://github.com/terrylinooo/airy-seo/blob/master/airyseo/Launcher.php"
    click EN "https://github.com/terrylinooo/airy-seo/blob/master/airyseo/Enums.php"
    click MT "https://github.com/terrylinooo/airy-seo/blob/master/airyseo/Modules/MetaTags.php"
    click FG "https://github.com/terrylinooo/airy-seo/blob/master/airyseo/Modules/FacebookOpenGraph.php"
    click TC "https://github.com/terrylinooo/airy-seo/blob/master/airyseo/Modules/TwitterCard.php"
    click AC "https://github.com/terrylinooo/airy-seo/blob/master/airyseo/Admin/Activation.php"
    click MN "https://github.com/terrylinooo/airy-seo/blob/master/airyseo/Admin/Menu.php"
    click ST "https://github.com/terrylinooo/airy-seo/blob/master/airyseo/Admin/Settings.php"
    click MB "https://github.com/terrylinooo/airy-seo/blob/master/airyseo/Admin/Metabox.php"
    click PS "https://github.com/terrylinooo/airy-seo/blob/master/airyseo/Admin/Posts.php"
    click AS "https://github.com/terrylinooo/airy-seo/blob/master/airyseo/Admin/Assets.php"
    click FView "https://github.com/terrylinooo/airy-seo/blob/master/views/modules/facebook-open-graph.php"
    click TView "https://github.com/terrylinooo/airy-seo/blob/master/views/modules/twitter-card.php"
    click AO1 "https://github.com/terrylinooo/airy-seo/blob/master/views/admin/options/facebook-open-graph.php"
    click AO2 "https://github.com/terrylinooo/airy-seo/blob/master/views/admin/options/twitter-card.php"
    click AO3 "https://github.com/terrylinooo/airy-seo/blob/master/views/admin/options.php"
    click MBV "https://github.com/terrylinooo/airy-seo/blob/master/views/admin/metabox.php"
    click PP "https://github.com/terrylinooo/airy-seo/blob/master/views/admin/parts/seo-column.php"
    click CSS "https://github.com/terrylinooo/airy-seo/blob/master/assets/css/style.css"
    click JS "https://github.com/terrylinooo/airy-seo/blob/master/assets/js/metabox.js"
    click UN "https://github.com/terrylinooo/airy-seo/blob/master/uninstall.php"
    click VND "https://github.com/terrylinooo/airy-seo/tree/master/vendor/"

    %% Styles
    classDef internal fill:#D0E8FF,stroke:#024B93,color:#000
    classDef core fill:#E0FFD0,stroke:#006400,color:#000
    classDef database fill:#E0FFD0,stroke:#006400,color:#000
    classDef external fill:#FFE0B2,stroke:#D2691E,color:#000
```
