AI Feedback Plugin

AI-powered editorial feedback for WordPress Gutenberg editor using WordPress 6.9's Notes feature.

Overview

The AI Feedback plugin integrates AI-powered content review directly into the WordPress block editor. It leverages the native Notes API (WordPress 6.9+) to provide contextual, block-level feedback on your content.

Features

🤖 AI-Powered Reviews: Get intelligent feedback on content quality, tone, flow, and design
📝 Native Notes Integration: Feedback appears as WordPress block comments
⚙️ Configurable Settings: Choose AI models, focus areas, and target tone
🔄 Multiple AI Providers: Support for Claude, GPT-4, Gemini, and more
💬 Conversational Feedback: Reply to AI suggestions and get clarifications (Phase 4)
🎯 Focus Areas: Content Quality, Tone & Voice, Flow & Structure, Design & Formatting

Requirements

WordPress: 6.9 or higher
PHP: 8.0 or higher
Plugins: WordPress AI Experiments plugin
Node.js: 18.0 or higher (for development)
npm: 9.0 or higher (for development)

Installation

Prerequisites

The AI Feedback plugin requires the WordPress AI Experiments plugin to be installed and activated. The AI Experiments plugin provides:

Centralized AI settings screen for configuring API keys
Support for multiple AI providers (Anthropic, OpenAI, Google Gemini, etc.)
Common interface for AI configuration across WordPress plugins

Install the AI Experiments plugin first:

Go to WordPress Admin → Plugins → Add New
Search for "AI Experiments" or "AI"
Click "Install Now" and then "Activate"
Configure your AI provider API keys in Settings → AI

1. Clone the Repository

git clone https://github.com/yourusername/ai-feedback.git
cd ai-feedback

2. Install Dependencies

# Install PHP dependencies
composer install

# Install JavaScript dependencies
npm install

3. Build Assets

# Production build
npm run build

# Development build with watch
npm run start

4. Set Up Local Environment (Optional)

# Start WordPress environment
npm run env:start

# The site will be available at http://localhost:8889
# Login: admin / password

5. Activate the Plugin

If using wp-env, the plugin is automatically activated. Otherwise:

Copy the plugin folder to wp-content/plugins/ai-feedback
Go to WordPress Admin → Plugins
Activate "AI Feedback"

Configuration

AI Provider Setup

The plugin uses the WordPress PHP AI Client which works in conjunction with the WordPress AI Experiments plugin for managing AI provider credentials.

Option 1: Using the AI Experiments Plugin (Recommended)

Configure your AI provider through the WordPress admin interface:

Go to Settings → AI in WordPress admin
Select your preferred AI provider (Anthropic, OpenAI, Google Gemini, etc.)
Enter your API key
Save settings

Option 2: Using wp-config.php

Alternatively, you can configure your AI provider directly in wp-config.php:

// For Anthropic Claude (default)
define( 'ANTHROPIC_API_KEY', 'your-api-key-here' );

// For OpenAI
define( 'OPENAI_API_KEY', 'your-api-key-here' );

// For Google Gemini
define( 'GOOGLE_AI_API_KEY', 'your-api-key-here' );

Default Settings

The plugin sets these defaults on activation:

Default Model: Claude Sonnet 4
Focus Areas: Content, Tone, Flow
Target Tone: Professional

You can change these in the plugin sidebar within the block editor.

Usage

Basic Review

Open a post in the block editor
Click the AI Feedback icon in the toolbar (or open from "Options" menu)
Adjust settings if needed:
- Select AI model
- Choose focus areas
- Set target tone
Click Review Document
AI will analyze your content and attach notes to relevant blocks

Working with Notes

📝 Notes appear as indicators on blocks with feedback
Click a note indicator to read the feedback
Each note includes:
- Title: Brief summary
- Feedback: Detailed explanation
- Suggestion: Actionable recommendation (if applicable)
- Severity: 🟢 Suggestion, 🟡 Important, 🔴 Critical

Reply to Feedback (Phase 4)

Once implemented, you'll be able to:

Click on a note to open it
Type a reply asking for clarification
AI will respond with context-aware suggestions

Development

Project Structure

ai-feedback/
├── ai-feedback.php           # Main plugin file
├── includes/                  # PHP classes
│   ├── class-plugin.php      # Bootstrap
│   ├── class-settings-controller.php
│   └── ...
├── src/                       # JavaScript/React source
│   ├── index.js              # Entry point
│   ├── store/                # WordPress data store
│   ├── components/           # React components
│   └── index.scss            # Styles
├── build/                     # Compiled assets (gitignored)
├── tests/                     # Test files
└── docs/                      # Documentation

Available Scripts

# Development
npm run start              # Watch mode with hot reload
npm run build              # Production build
npm run format             # Format code with Prettier

# Linting
npm run lint:js            # ESLint
npm run lint:css           # Stylelint
npm run lint:pkg-json      # Package.json validation
npm run lint:php           # PHPCS + PHPStan

# Testing
npm run test:unit          # JavaScript unit tests
npm run test:php           # PHP unit tests
composer test              # PHP unit tests (alternative)
npm run test:e2e           # End-to-end tests
npm run test:all           # Run JS linting and tests

# WordPress Environment
npm run env:start          # Start wp-env
npm run env:stop           # Stop wp-env
npm run env:clean          # Clean wp-env

# Build
npm run plugin-zip         # Create release zip

Running Tests

# JavaScript tests (Jest)
npm run test:unit

# PHP tests (PHPUnit)
composer test

# E2E tests (Playwright)
npm run test:e2e

# Run all tests
npm run test:all

Code Standards

The plugin follows:

PHP: WordPress Coding Standards
JavaScript: WordPress ESLint configuration
CSS: WordPress Stylelint configuration

Continuous Integration

All pull requests automatically run through GitHub Actions CI/CD:

✅ JavaScript linting (ESLint, Stylelint, Prettier)
✅ PHP linting (PHPCS, PHPStan)
✅ JavaScript unit tests (Jest)
✅ PHP unit tests (PHPUnit) across PHP 8.1-8.3

See docs/CI.md for details on running checks locally and setting up branch protection.

Architecture

PHP Backend

Settings Controller: REST API for settings management
Review Service: Orchestrates document analysis (Phase 2)
Reply Service: Handles conversational feedback (Phase 4)
Notes Manager: Creates and manages Notes (Phase 3)
Prompt Builder: Constructs AI prompts (Phase 2)

JavaScript Frontend

WordPress Data Store: State management with @wordpress/data
React Components: UI built with WordPress components
REST API Integration: Communicates with PHP backend

Data Flow

Editor → Plugin Sidebar → Data Store → REST API → PHP Services → AI Client → AI Provider
                                                                              ↓
Editor ← Notes API ← Notes Manager ← Response Parser ← AI Client ← AI Response

Project Status

Current phase: Phase 5 (Polish & Release) — in progress. Phase 4 (Conversation Loop) is the remaining major feature and has not yet started.

Phase 1: Foundation ✅ Complete

Plugin scaffold with build system
Plugin sidebar UI with settings
Model selector with provider grouping
Focus areas and tone selection
Settings REST API with caching
WordPress data store (selectors, actions, reducer)
Review button with loading states

Phase 2: AI Integration & Review ✅ Complete

Review Service with block parsing
Prompt engineering for different focus areas
AI response parsing and validation
Review REST endpoint
Error handling and rate limiting

Phase 3: Notes Integration ✅ Complete

Notes Manager for WordPress Notes API
Block-level note indicators
Note resolution tracking
Review history display

Phase 4: Conversation Loop 🚧 Not started

Tracked in issues #131–#134.

Reply detection hook (#131)
Context-aware reply prompts / Reply Service (#132)
Async reply processing (#133)
Conversation threading UI (#134)

Phase 5: Polish & Release 🚧 In progress

API Documentation

See docs/API.md for complete REST API documentation.

Testing Documentation

See docs/TESTING.md for comprehensive testing guide.

Contributing

Contributions are welcome! Please:

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Development Guidelines

Follow WordPress coding standards
Write tests for new features
Update documentation as needed
Ensure all tests pass before submitting PR

License

GPL v2 or later

Credits

Requires WordPress AI Experiments plugin
Built with WordPress PHP AI Client
Uses WordPress 6.9+ Notes API
Powered by AI providers: Anthropic, OpenAI, Google

Support

Issues: GitHub Issues
Documentation: docs/
WordPress: Requires 6.9+

Changelog

0.1.0 (Current)

Plugin scaffold and build system
Settings UI, REST API, and data store
Model selection with provider grouping
Focus areas and tone configuration
Document review with AI provider integration (Anthropic, OpenAI, Gemini)
Prompt builder with focus-area and block-type specific instructions
Few-shot examples for consistent AI output
Multi-language feedback support
Feedback deduplication and grouping
WordPress Notes API integration (block-level comments)
Health check REST endpoint
Accessibility: skip links, visible focus indicators, WCAG AA color contrast, ARIA live regions
Onboarding: first-run welcome modal, empty state guidance
E2E test infrastructure with Playwright

Coming Soon

Phase 4: Conversational replies to AI feedback
Phase 5: Abilities API, streaming responses, performance optimization, final accessibility audit, complete documentation, v1.0.0 release

Built with ❤️ for WordPress

Name		Name	Last commit message	Last commit date
Latest commit History 259 Commits
.github		.github
.wordpress-org		.wordpress-org
assets		assets
docs		docs
includes		includes
src		src
tests		tests
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.nvmrc		.nvmrc
.stylelintrc.json		.stylelintrc.json
.wp-env.json		.wp-env.json
CLAUDE.md		CLAUDE.md
CONTRIBUTING.md		CONTRIBUTING.md
DESIGN.md		DESIGN.md
README.md		README.md
ai-feedback.php		ai-feedback.php
composer.json		composer.json
composer.lock		composer.lock
gemini-plan.md		gemini-plan.md
package-lock.json		package-lock.json
package.json		package.json
phpstan.neon		phpstan.neon
phpunit.xml		phpunit.xml
playwright.config.js		playwright.config.js
readme.txt		readme.txt

Folders and files

Latest commit

History

Repository files navigation

AI Feedback Plugin

Overview

Features

Requirements

Installation

Prerequisites

1. Clone the Repository

2. Install Dependencies

3. Build Assets

4. Set Up Local Environment (Optional)

5. Activate the Plugin

Configuration

AI Provider Setup

Default Settings

Usage

Basic Review

Working with Notes

Reply to Feedback (Phase 4)

Development

Project Structure

Available Scripts

Running Tests

Code Standards

Continuous Integration

Architecture

PHP Backend

JavaScript Frontend

Data Flow

Project Status

Phase 1: Foundation ✅ Complete

Phase 2: AI Integration & Review ✅ Complete

Phase 3: Notes Integration ✅ Complete

Phase 4: Conversation Loop 🚧 Not started

Phase 5: Polish & Release 🚧 In progress

API Documentation

Testing Documentation

Contributing

Development Guidelines

License

Credits

Support

Changelog

0.1.0 (Current)

Coming Soon

About

Resources

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Packages