## Contents

# Documentation

Plugin Compass is an AI builder for creating custom WordPress plugins. Describe what you want, review a clear plan, then let the builder generate and iterate on production-ready code.

## Best for

- Replacing expensive plugin subscriptions with a plugin you own
- Building admin panels, dashboards, forms, and workflow automations
- Creating custom post types, taxonomies, shortcodes, and Gutenberg blocks
- Integrating with third-party APIs (CRMs, email providers, internal services)

## Before you ship

- Test on a staging site and keep WordPress + plugins up to date
- Review permissions, sanitization, and nonces on admin actions
- Confirm your plugin doesn’t break theme templates or existing workflows

## Quick start

The fastest path from idea → plugin ZIP.

1. Create an account at /signup (or sign in at /login).
2. After verification you’ll be asked to pick a plan (if you haven’t already), then you’ll land on /apps.
3. Click Create New Plugin to open the builder.
4. Start with a detailed request (use the template below).
5. Review the plan, approve it, then let the builder generate code.
6. Click Download ZIP to export your plugin and install it in WordPress.

### Starter prompt template

Copy/paste this into the builder and fill in the brackets.

    Build me a WordPress plugin called: [Plugin Name]

    Goal:
    - [What business problem it solves]

    Users & permissions:
    - Admin can: [list]
    - Editor can: [list]
    - Logged-out users can: [list]

    Admin UI:
    - Add a new menu item under: [Tools / Settings / custom top-level]
    - Screens needed:
      1) [Screen name] - [what it does]
      2) [Screen name] - [what it does]

    Data model:
    - Store data as: [options / post meta / custom table]
    - Fields:
      - [field] (type) - validation rules

    Workflows:
    - When [event] happens, do [action]
    - Send email/notification to [who] when [condition]

    Acceptance criteria:
    - [bullet list of “done” conditions]

## Projects & sessions

Each plugin you build lives in its own project (also called a session). Sessions keep your chat history, plan approvals, and generated files together.

### Create & manage projects

- Go to /apps to see all projects.
- Rename a project to match the plugin’s purpose (e.g. “Membership Portal”).
- Delete old experiments to keep your dashboard clean.

### Import an existing plugin (paid plans)

If you already have a plugin ZIP, you can upload it from /apps and continue iterating in the builder. This is great for adding features, fixing bugs, or modernizing an older plugin.

## Builder workflow

A predictable loop: plan → approve → build → iterate.

### 1) Plan

- Clarifies requirements and edge cases before code is generated
- Proposes screens, data storage, and a file layout
- Lists acceptance criteria so you can quickly verify “done”

If anything is missing, reply with changes (e.g. “add role-based access” or “store data in a custom table”).

### 2) Build

- Generates plugin scaffolding, admin UI, and core logic
- Updates existing files instead of starting over when you request changes
- Surfaces progress and keeps context in the project session

Iteration works best when you describe the desired behavior and include exact error messages or screenshots.

### Common iteration requests

“Add a settings screen for API keys and validate input.”
“Fix the activation error and add a database migration routine.”
“Make the admin table sortable + add search and filters.”
“Add WP-CLI commands for batch processing.”

## Writing a great spec

The more specific your inputs, the more reliable the output.

### Include these details

- Actors: who uses it (admin, editor, member, guest)
- Data: what you store, where it lives, and retention requirements
- UI: what screens exist and what actions each screen supports
- Rules: validation, permissions, and edge cases
- Acceptance criteria: concrete checks to confirm it’s correct

### When reporting a bug

- Exact WordPress version + PHP version
- What you expected vs what happened
- Any fatal error text from the WP debug log
- The exact page URL and steps to reproduce

### Examples of “good” vs “better”

Good

“Make a plugin to collect leads.”

Better

“Add a lead capture form shortcode with name/email/company fields, store submissions in a custom table, add an admin list screen with search + CSV export, and send a notification email to the site admin.”

## Export & install

Download your plugin as a ZIP and install it like any other WordPress plugin.

### Export from the builder

1. Open your project in the builder.
2. Click Download ZIP.
3. Save the ZIP locally (don’t unzip it for WordPress upload).

### Install in WordPress

1. In wp-admin: Plugins → Add New → Upload Plugin.
2. Select the exported ZIP and click Install Now.
3. Click Activate.

### Recommended deployment flow

- Install on a staging environment first.
- Enable `WP_DEBUG` to catch notices/fatals early.
- Only deploy to production once you’ve validated permissions, forms, and edge-case behavior.

## Billing & account

Manage your subscription and payment method from settings.

### Plans

- New users are prompted to choose a plan after email verification.
- Plan limits can affect things like project count, usage, and importing existing plugins.
- You can upgrade or downgrade later.

### Settings

- Visit /settings to manage your account.
- Update your payment method at any time.
- Cancel or resume a subscription from the same page.

## Security best practices

WordPress plugins run inside your site—treat them like production software.

### Admin actions

- Use capability checks (e.g. `manage_options`)
- Protect form submissions with nonces
- Sanitize input and validate server-side
- Escape output in templates and admin screens

### Data handling

- Store secrets (API keys) in the options table and restrict access
- Avoid logging sensitive data
- Use prepared statements for custom SQL queries
- Document retention/export/deletion requirements when you collect personal data

## Troubleshooting

Common issues and how to resolve them quickly.

### I can’t access the dashboard / builder

- Make sure you’re signed in (try /login).
- If you’re redirected to plan selection, choose a plan first.
- If you recently changed browsers/devices, your session cookie may be missing—sign in again.

### My export ZIP is empty

- Make sure you’ve completed at least one build step that generates files.
- Try asking the builder to list the files it created, then export again.

### The plugin fails to activate on WordPress

- Enable WP debug logging and capture the exact fatal error text.
- Share the error message with the builder and ask for a fix.
- Confirm your hosting PHP version meets the plugin’s requirements.

## Support

Need help refining a plugin or debugging an issue?

- Start with your project session in the builder and describe the goal or issue.
- Include URLs, screenshots, and exact error text whenever possible.
- Check /settings for account and plan status.

## Build Your Custom Plugin Today

Start building WordPress plugins that fit your exact needs. No coding experience required.

Get Started Free