home / skills / automattic / agent-skills / wp-plugin-development

wp-plugin-development skill

/skills/wp-plugin-development

This skill helps you develop secure, maintainable WordPress plugins by guiding architecture, hooks, settings, migrations, and packaging.

npx playbooks add skill automattic/agent-skills --skill wp-plugin-development

Review the files below or copy the command above to add this skill to your agents.

Files (8)
SKILL.md
3.9 KB
---
name: wp-plugin-development
description: "Use when developing WordPress plugins: architecture and hooks, activation/deactivation/uninstall, admin UI and Settings API, data storage, cron/tasks, security (nonces/capabilities/sanitization/escaping), and release packaging."
compatibility: "Targets WordPress 6.9+ (PHP 7.2.24+). Filesystem-based agent with bash + node. Some workflows require WP-CLI."
---

# WP Plugin Development

## When to use

Use this skill for plugin work such as:

- creating or refactoring plugin structure (bootstrap, includes, namespaces/classes)
- adding hooks/actions/filters
- activation/deactivation/uninstall behavior and migrations
- adding settings pages / options / admin UI (Settings API)
- security fixes (nonces, capabilities, sanitization/escaping, SQL safety)
- packaging a release (build artifacts, readme, assets)

## Inputs required

- Repo root + target plugin(s) (path to plugin main file if known).
- Where this plugin runs: single site vs multisite; WP.com conventions if applicable.
- Target WordPress + PHP versions (affects available APIs and placeholder support in `$wpdb->prepare()`).

## Procedure

### 0) Triage and locate plugin entrypoints

1. Run triage:
   - `node skills/wp-project-triage/scripts/detect_wp_project.mjs`
2. Detect plugin headers (deterministic scan):
   - `node skills/wp-plugin-development/scripts/detect_plugins.mjs`

If this is a full site repo, pick the specific plugin under `wp-content/plugins/` or `mu-plugins/` before changing code.

### 1) Follow a predictable architecture

Guidelines:

- Keep a single bootstrap (main plugin file with header).
- Avoid heavy side effects at file load time; load on hooks.
- Prefer a dedicated loader/class to register hooks.
- Keep admin-only code behind `is_admin()` (or admin hooks) to reduce frontend overhead.

See:
- `references/structure.md`

### 2) Hooks and lifecycle (activation/deactivation/uninstall)

Activation hooks are fragile; follow guardrails:

- register activation/deactivation hooks at top-level, not inside other hooks
- flush rewrite rules only when needed and only after registering CPTs/rules
- uninstall should be explicit and safe (`uninstall.php` or `register_uninstall_hook`)

See:
- `references/lifecycle.md`

### 3) Settings and admin UI (Settings API)

Prefer Settings API for options:

- `register_setting()`, `add_settings_section()`, `add_settings_field()`
- sanitize via `sanitize_callback`

See:
- `references/settings-api.md`

### 4) Security baseline (always)

Before shipping:

- Validate/sanitize input early; escape output late.
- Use nonces to prevent CSRF *and* capability checks for authorization.
- Avoid directly trusting `$_POST` / `$_GET`; use `wp_unslash()` and specific keys.
- Use `$wpdb->prepare()` for SQL; avoid building SQL with string concatenation.

See:
- `references/security.md`

### 5) Data storage, cron, migrations (if needed)

- Prefer options for small config; custom tables only if necessary.
- For cron tasks, ensure idempotency and provide manual run paths (WP-CLI or admin).
- For schema changes, write upgrade routines and store schema version.

See:
- `references/data-and-cron.md`

## Verification

- Plugin activates with no fatals/notices.
- Settings save and read correctly (capability + nonce enforced).
- Uninstall removes intended data (and nothing else).
- Run repo lint/tests (PHPUnit/PHPCS if present) and any JS build steps if the plugin ships assets.

## Failure modes / debugging

- Activation hook not firing:
  - hook registered incorrectly (not in main file scope), wrong main file path, or plugin is network-activated
- Settings not saving:
  - settings not registered, wrong option group, missing capability, nonce failure
- Security regressions:
  - nonce present but missing capability checks; or sanitized input not escaped on output

See:
- `references/debugging.md`

## Escalation

For canonical detail, consult the Plugin Handbook and security guidelines before inventing patterns.

Overview

This skill helps develop and harden WordPress plugins across architecture, lifecycle hooks, admin UI, data handling, security, cron/tasks, and release packaging. It focuses on predictable structure, safe activation/deactivation/uninstall, Settings API usage, and secure input/output handling. Use it to ensure plugins are maintainable, upgrade-safe, and ready for release.

How this skill works

The skill inspects plugin entry points and identifies the main bootstrap file and hook registrations. It evaluates structure (loader patterns, admin vs frontend separation), lifecycle hooks, settings implementation, data storage choices, cron tasks, and security controls (nonces, capabilities, sanitization/escaping). It also verifies activation behavior, settings persistence, uninstall cleanup, and build/release readiness.

When to use it

  • Creating or refactoring plugin structure and bootstrap patterns
  • Adding or auditing actions, filters, and lifecycle hooks
  • Implementing settings pages and managing options via the Settings API
  • Hardening security: nonces, capability checks, sanitization, escaping, SQL safety
  • Designing data storage, cron tasks, migrations, and upgrade routines
  • Preparing a plugin release: build artifacts, readme, and packaging

Best practices

  • Keep a single main bootstrap file that registers a loader or main class and avoid heavy side effects during file load
  • Register activation/deactivation/uninstall hooks at top level and write safe, idempotent upgrade routines
  • Use the Settings API (register_setting, add_settings_section/field) and sanitize inputs via callbacks
  • Always validate and sanitize input early; escape output late; enforce nonces and capability checks for any state-changing actions
  • Prefer WP options for small data; use custom tables only when justified and track schema version for migrations
  • Make cron tasks idempotent and expose manual run paths (WP-CLI or admin) for debugging

Example use cases

  • Refactor a plugin to use a loader class and defer admin-only code behind admin hooks
  • Add a settings page using the Settings API with proper sanitize callbacks and capability checks
  • Implement activation migration that creates a custom table and stores a schema version for future upgrades
  • Audit a plugin for security issues: missing nonces, direct use of $_POST/$_GET, and unsafe SQL concatenation
  • Package a release: build JS/CSS assets, update readme and changelog, and ensure activation runs without errors

FAQ

What checks should I run after making changes?

Activate the plugin (single and network if applicable), save settings, run any cron tasks or upgrade routines, and run lint/tests and asset builds if present.

When should I use a custom table instead of options?

Use a custom table only when data volume or query complexity cannot be handled efficiently by options or post/meta APIs; always provide schema versioning and migrations.

How to avoid activation hook failures?

Register hooks at top-level in the main plugin file, ensure the main plugin path is correct, and account for network-activation differences.