# timezhero/acf-icon-picker architecture

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

- Interactive diagram: https://gitdiagram.com/timezhero/acf-icon-picker
- Repository: https://github.com/timezhero/acf-icon-picker

## Overview

##### File structure
- composer.json: makes the plugin installable via Composer.
- assets/
- screenshots/: example UI screenshot.

##### README for additional insights
- Mentions integration patterns (Sage/Bedrock filter overrides).

a. Main components
- WordPress Core
- ACF Plugin
– Assets (CSS/JS, Images)
- External Systems: GitHub/Composer repository (for installation)
b. Relationships and data flows
2. When a user edits a post/page and opens an ACF field group, ACF renders the custom field UI by loading the plugin’s CSS/JS assets.
6. Composer/GitHub only come into play at development/deployment time (installation).
c. Architectural patterns / design principles
– Separation of concerns:
- PHP backend for registering and loading field code
- Static assets for admin UI experience
- Configuration via Composer or WP filters
d. Key technologies & libraries
- PHP 7+ (WordPress plugin API)
- ACF 5+ (field registration hooks)
- CSS (Tailwind-ish input.css)
- Vanilla JS (assets/js/input.js)
- Composer package management

##### Elements
- From plugin bootstrap → ACF hooks
- From browser (admin) → JS/CSS assets → field UI
- From field UI → DB (saving meta) → get_field() → front-end render
- Core WP/ACF in gray
- Assets (CSS/JS/img) in green
- External install mechanisms in orange

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Installation Flow
    subgraph "External Installation"
        GitHub["GitHub Repository"]:::external
        ComposerDef["composer.json"]:::external
        GitHub -->|"provides"| ComposerDef
        ComposerDef -->|"install plugin"| PluginFolder["Plugin Folder"]:::plugin
    end

    %% WordPress Environment
    subgraph "WordPress Environment"
        WP["WordPress Core"]:::core
        ACF["ACF Plugin"]:::core
        WP --> ACF
        ACF -->|"acf/include_field_types hook"| Bootstrap["Plugin Bootstrap<br>acf-icon-picker.php"]:::plugin
        Bootstrap -->|"register field type"| FieldClass["Field Type Class<br>fields/acf-icon-picker-v5.php"]:::plugin

        subgraph "Icon-Picker Plugin Internals"
            Bootstrap
            FieldClass
            ComposerDef
            Docs["README.md<br>& Screenshots"]:::plugin
            Bootstrap --> Docs

            subgraph "Assets"
                CSS["Admin UI Stylesheet<br>assets/css/input.css"]:::assets
                JS["Admin UI Script<br>assets/js/input.js"]:::assets
                IMG["Icon Assets Directory<br>assets/img/"]:::assets
            end

            Bootstrap --> CSS
            Bootstrap --> JS
            JS --> IMG
        end
    end

    %% Admin UI and Data Flow
    Browser["Admin Browser"]:::external
    Browser -->|"load assets"| CSS
    Browser -->|"load assets"| JS
    CSS & JS --> UI["Icon-Picker UI"]:::plugin
    UI -->|"select icon"| DB["WP Database (postmeta)"]:::core
    DB -->|"get_field() returns icon ID"| Frontend["Front End Rendering"]:::plugin
    Frontend -->|"renders image/svg"| IMG

    %% Click Events
    click Bootstrap "https://github.com/timezhero/acf-icon-picker/blob/master/acf-icon-picker.php"
    click FieldClass "https://github.com/timezhero/acf-icon-picker/blob/master/fields/acf-icon-picker-v5.php"
    click CSS "https://github.com/timezhero/acf-icon-picker/blob/master/assets/css/input.css"
    click JS "https://github.com/timezhero/acf-icon-picker/blob/master/assets/js/input.js"
    click IMG "https://github.com/timezhero/acf-icon-picker/tree/master/assets/img/"
    click ComposerDef "https://github.com/timezhero/acf-icon-picker/blob/master/composer.json"
    click Docs "https://github.com/timezhero/acf-icon-picker/blob/master/README.md"
    click Docs "https://github.com/timezhero/acf-icon-picker/tree/master/screenshots/"

    %% Styles
    classDef core fill:#cccccc,stroke:#333,stroke-width:1px
    classDef plugin fill:#cce5ff,stroke:#337ab7,stroke-width:1px
    classDef assets fill:#d4edda,stroke:#155724,stroke-width:1px
    classDef external fill:#ffe5b4,stroke:#cc7a00,stroke-width:1px
```
