Compare commits
19
Commits
0e6f9639f4
...
v0.1.7
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
93412896e8 | ||
|
|
6784ef4824 | ||
|
|
0874c4f59e | ||
|
|
4696cdfba6 | ||
|
|
1cf46254b7 | ||
|
|
3c1db9d4fb | ||
|
|
bfa528c90e | ||
|
|
233a64913b | ||
|
|
1c049a91c5 | ||
|
|
1e2f7a5cd8 | ||
|
|
7072f21d49 | ||
|
|
af48e84614 | ||
|
|
5083fcee50 | ||
|
|
79d1314aed | ||
|
|
2f4d88f8dd | ||
|
|
bfac63799b | ||
|
|
9d3e67d16b | ||
|
|
843696d3a8 | ||
|
|
269626438e |
No files matched your search
@@ -150,7 +150,15 @@ If the plugin is hosted on WordPress.org:
|
||||
|
||||
After releasing a new version:
|
||||
|
||||
1. Update the wiki documentation if needed
|
||||
2. Announce the release in relevant channels
|
||||
3. Monitor for any issues or feedback
|
||||
4. Start planning the next release
|
||||
1. Update the wiki documentation:
|
||||
- Update the Changelog.md file in the .wiki directory to match the main CHANGELOG.md
|
||||
- Add the new version information to the Home.md file in the Latest Updates section
|
||||
- Ensure all wiki pages are up-to-date with the new features or changes
|
||||
- Verify that the _Sidebar.md file has the correct navigation structure
|
||||
2. Verify that GitHub Actions workflows are running correctly:
|
||||
- Check that the release workflow created the release with the correct assets
|
||||
- Check that the sync-wiki workflow synced the wiki changes
|
||||
- Fix any permissions issues in the workflow files if needed
|
||||
3. Announce the release in relevant channels
|
||||
4. Monitor for any issues or feedback
|
||||
5. Start planning the next release
|
||||
@@ -8,6 +8,7 @@ The wiki documentation is organized into the following sections:
|
||||
|
||||
1. **User Documentation**:
|
||||
- Home
|
||||
- Starter Prompt (must be listed before Installation Guide)
|
||||
- Installation Guide
|
||||
- Usage Instructions
|
||||
- Frequently Asked Questions
|
||||
@@ -88,8 +89,10 @@ Documentation should be updated:
|
||||
|
||||
1. Identify the relevant wiki file(s) in the `.wiki/` directory
|
||||
2. Make the necessary changes
|
||||
3. Commit and push the changes to the `main` branch
|
||||
4. The GitHub Actions workflow will automatically sync the changes with the GitHub wiki
|
||||
3. **Always ensure the Changelog.md in the wiki is updated to match the main CHANGELOG.md file**
|
||||
4. **Always ensure the _Sidebar.md file has the correct navigation structure with Starter Prompt listed before Installation Guide**
|
||||
5. Commit and push the changes to the `main` branch
|
||||
6. The GitHub Actions workflow will automatically sync the changes with the GitHub wiki
|
||||
|
||||
### Creating New Pages
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
name: Release
|
||||
name: Release - Build and publish plugin releases
|
||||
|
||||
on:
|
||||
push:
|
||||
@@ -10,6 +10,8 @@ jobs:
|
||||
build:
|
||||
name: Build and Release
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
@@ -36,31 +38,31 @@ jobs:
|
||||
|
||||
- name: Create build directory
|
||||
run: |
|
||||
mkdir -p build/wp-plugin-starter-template
|
||||
cp -R *.php README.md LICENSE CHANGELOG.md readme.txt composer.json build/wp-plugin-starter-template/
|
||||
cp -R admin includes languages vendor build/wp-plugin-starter-template/
|
||||
mkdir -p build/wp-plugin-starter-template/assets/banner build/wp-plugin-starter-template/assets/icon build/wp-plugin-starter-template/assets/screenshots
|
||||
if [ -d "assets/banner" ]; then cp -R assets/banner/* build/wp-plugin-starter-template/assets/banner/; fi
|
||||
if [ -d "assets/icon" ]; then cp -R assets/icon/* build/wp-plugin-starter-template/assets/icon/; fi
|
||||
if [ -d "assets/screenshots" ]; then cp -R assets/screenshots/* build/wp-plugin-starter-template/assets/screenshots/; fi
|
||||
mkdir -p build/wp-plugin-starter-template-for-ai-coding
|
||||
cp -R *.php README.md LICENSE CHANGELOG.md readme.txt composer.json build/wp-plugin-starter-template-for-ai-coding/
|
||||
cp -R admin includes languages vendor build/wp-plugin-starter-template-for-ai-coding/
|
||||
mkdir -p build/wp-plugin-starter-template-for-ai-coding/assets/banner build/wp-plugin-starter-template-for-ai-coding/assets/icon build/wp-plugin-starter-template-for-ai-coding/assets/screenshots
|
||||
if [ -d "assets/banner" ]; then cp -R assets/banner/* build/wp-plugin-starter-template-for-ai-coding/assets/banner/; fi
|
||||
if [ -d "assets/icon" ]; then cp -R assets/icon/* build/wp-plugin-starter-template-for-ai-coding/assets/icon/; fi
|
||||
if [ -d "assets/screenshots" ]; then cp -R assets/screenshots/* build/wp-plugin-starter-template-for-ai-coding/assets/screenshots/; fi
|
||||
|
||||
- name: Create ZIP file
|
||||
run: |
|
||||
cd build
|
||||
zip -r ../wp-plugin-starter-template-${{ env.VERSION }}.zip wp-plugin-starter-template -x "*.DS_Store" -x "*.git*"
|
||||
zip -r ../wp-plugin-starter-template-for-ai-coding-${{ env.VERSION }}.zip wp-plugin-starter-template-for-ai-coding -x "*.DS_Store" -x "*.git*"
|
||||
cd ..
|
||||
|
||||
- name: Create Release
|
||||
id: create_release
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
files: wp-plugin-starter-template-${{ env.VERSION }}.zip
|
||||
files: wp-plugin-starter-template-for-ai-coding-${{ env.VERSION }}.zip
|
||||
name: Version ${{ env.VERSION }}
|
||||
draft: false
|
||||
prerelease: false
|
||||
body: |
|
||||
Release of version ${{ env.VERSION }}
|
||||
|
||||
|
||||
See [CHANGELOG.md](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/blob/main/CHANGELOG.md) for details.
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -1,4 +1,4 @@
|
||||
name: Sync Wiki
|
||||
name: Sync Wiki - Update GitHub wiki from .wiki directory
|
||||
|
||||
on:
|
||||
push:
|
||||
@@ -11,6 +11,8 @@ jobs:
|
||||
sync-wiki:
|
||||
name: Sync Wiki to GitHub
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- name: Checkout source code
|
||||
uses: actions/checkout@v3
|
||||
@@ -23,29 +25,29 @@ jobs:
|
||||
- name: Clone wiki repository
|
||||
run: |
|
||||
git clone https://github.com/${{ github.repository }}.wiki.git wiki
|
||||
|
||||
|
||||
- name: Sync wiki content
|
||||
run: |
|
||||
# Remove all files from wiki repository except .git
|
||||
find wiki -mindepth 1 -maxdepth 1 -not -name '.git' -exec rm -rf {} \;
|
||||
|
||||
|
||||
# Copy .wiki content to wiki repository
|
||||
cp -r .wiki/* wiki/
|
||||
|
||||
|
||||
# Go to wiki repository
|
||||
cd wiki
|
||||
|
||||
|
||||
# Add all changes
|
||||
git add .
|
||||
|
||||
|
||||
# Check if there are changes to commit
|
||||
if git diff --staged --quiet; then
|
||||
echo "No changes to commit"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
|
||||
# Commit changes
|
||||
git commit -m "Sync wiki from source repository"
|
||||
|
||||
|
||||
# Push changes
|
||||
git push https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.wiki.git
|
||||
@@ -1,4 +1,4 @@
|
||||
name: Tests
|
||||
name: Tests - Run PHP compatibility and unit tests
|
||||
|
||||
on:
|
||||
push:
|
||||
@@ -13,7 +13,8 @@ jobs:
|
||||
strategy:
|
||||
matrix:
|
||||
php-versions: ['7.0', '7.4', '8.0']
|
||||
|
||||
fail-fast: false
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
@@ -26,7 +27,11 @@ jobs:
|
||||
tools: composer:v2
|
||||
|
||||
- name: Install dependencies
|
||||
run: composer install --prefer-dist --no-progress
|
||||
run: |
|
||||
if [[ "${{ matrix.php-versions }}" == "7.0" ]]; then
|
||||
composer require --dev phpunit/phpunit:"^6.5" --update-with-dependencies
|
||||
fi
|
||||
composer install --prefer-dist --no-progress
|
||||
|
||||
- name: Run tests
|
||||
run: ./vendor/bin/phpunit
|
||||
@@ -34,7 +39,7 @@ jobs:
|
||||
code-style:
|
||||
name: Code Style
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
@@ -50,4 +55,4 @@ jobs:
|
||||
run: composer install --prefer-dist --no-progress
|
||||
|
||||
- name: Run PHPCS
|
||||
run: ./vendor/bin/phpcs --standard=WordPress
|
||||
run: ./vendor/bin/phpcs --standard=WordPress --runtime-set installed_paths vendor/wp-coding-standards/wpcs ./includes ./admin ./wp-plugin-starter-template.php
|
||||
@@ -0,0 +1,108 @@
|
||||
# AI Workflow Documentation
|
||||
|
||||
This document provides an overview of the AI-assisted development workflows for this plugin.
|
||||
|
||||
## Introduction to AI-Assisted Development
|
||||
|
||||
AI-assisted development uses artificial intelligence tools to help with coding, documentation, testing, and other development tasks. This plugin is designed to work seamlessly with AI assistants to make development faster and more efficient.
|
||||
|
||||
## Setting Up Your AI Environment
|
||||
|
||||
### Required Files
|
||||
|
||||
To get the most out of AI-assisted development, make sure to include these files in your AI IDE context:
|
||||
|
||||
1. **.ai-assistant.md**: Contains essential information about the project structure and conventions
|
||||
2. **.ai-workflows/**: Directory containing detailed workflow documentation for common tasks
|
||||
|
||||
### Pinning Files in AI IDEs
|
||||
|
||||
For the best results, pin these files in your AI IDE chat context:
|
||||
|
||||
- **Claude**: Use the "Pin" feature to keep files in context
|
||||
- **GitHub Copilot**: Use the "Pin" feature in the chat interface
|
||||
- **ChatGPT**: Use the "Pin" feature in the Advanced Data Analysis mode
|
||||
- **Other AI IDEs**: Refer to your specific IDE's documentation for pinning files
|
||||
|
||||
## AI Workflow Files
|
||||
|
||||
The `.ai-workflows/` directory contains detailed guides for common development tasks:
|
||||
|
||||
1. **plugin-customization.md**: Guide for customizing the plugin for specific needs
|
||||
2. **feature-development.md**: Workflow for developing new features
|
||||
3. **bug-fixing.md**: Process for identifying and fixing bugs
|
||||
4. **testing.md**: Guide for writing and running tests
|
||||
5. **documentation.md**: Workflow for updating documentation
|
||||
6. **release-process.md**: Steps for creating new releases
|
||||
7. **wiki-documentation.md**: Guide for maintaining wiki documentation
|
||||
|
||||
## Using the Starter Prompt
|
||||
|
||||
The [Starter Prompt](Starter-Prompt) is a comprehensive guide for AI tools to help customize the template for your specific plugin. It includes:
|
||||
|
||||
1. **Project Overview**: Description of the plugin and its purpose
|
||||
2. **Customization Steps**: Detailed steps for customizing the template
|
||||
3. **File Structure**: Overview of the plugin's file structure
|
||||
4. **Coding Standards**: Guidelines for code style and quality
|
||||
5. **Testing Requirements**: Instructions for testing the plugin
|
||||
|
||||
## AI-Assisted Development Workflows
|
||||
|
||||
### Customizing the Plugin
|
||||
|
||||
1. Open your AI IDE and pin the `.ai-assistant.md` file and `.ai-workflows/` directory
|
||||
2. Provide the Starter Prompt to the AI
|
||||
3. Follow the AI's guidance to customize the plugin
|
||||
4. Review and test the changes
|
||||
|
||||
### Developing New Features
|
||||
|
||||
1. Define the feature requirements
|
||||
2. Ask the AI to help design the feature
|
||||
3. Implement the feature with AI assistance
|
||||
4. Write tests for the feature
|
||||
5. Update documentation
|
||||
|
||||
### Fixing Bugs
|
||||
|
||||
1. Describe the bug to the AI
|
||||
2. Ask the AI to help identify the cause
|
||||
3. Implement the fix with AI assistance
|
||||
4. Write tests to prevent regression
|
||||
5. Update documentation if necessary
|
||||
|
||||
### Writing Tests
|
||||
|
||||
1. Describe the functionality to be tested
|
||||
2. Ask the AI to help write unit tests
|
||||
3. Ask the AI to help write end-to-end tests
|
||||
4. Run the tests and fix any issues
|
||||
|
||||
### Updating Documentation
|
||||
|
||||
1. Describe the changes that need documentation
|
||||
2. Ask the AI to help update the relevant documentation files
|
||||
3. Review and refine the documentation
|
||||
|
||||
## Best Practices for AI-Assisted Development
|
||||
|
||||
1. **Be Specific**: Provide clear, detailed instructions to the AI
|
||||
2. **Review Carefully**: Always review AI-generated code before committing
|
||||
3. **Iterative Approach**: Work with the AI in small, iterative steps
|
||||
4. **Provide Context**: Keep relevant files in the AI's context
|
||||
5. **Ask Questions**: If you're unsure about something, ask the AI to explain
|
||||
6. **Test Thoroughly**: Always test AI-generated code
|
||||
|
||||
## Troubleshooting AI Assistance
|
||||
|
||||
If you encounter issues with AI assistance:
|
||||
|
||||
1. **Refresh Context**: Sometimes the AI may lose context. Try refreshing the conversation or repinning files
|
||||
2. **Be More Specific**: Provide more detailed instructions
|
||||
3. **Break Down Tasks**: Divide complex tasks into smaller, manageable parts
|
||||
4. **Provide Examples**: Show examples of what you want
|
||||
5. **Try Different Approaches**: If one approach doesn't work, try a different one
|
||||
|
||||
## Conclusion
|
||||
|
||||
AI-assisted development can significantly speed up your workflow and improve code quality. By following these guidelines and using the provided AI workflow documentation, you can make the most of AI tools in your development process.
|
||||
@@ -0,0 +1,111 @@
|
||||
# Architecture Overview
|
||||
|
||||
This document provides an overview of the plugin's architecture, explaining the core components and how they interact.
|
||||
|
||||
## Directory Structure
|
||||
|
||||
The plugin follows a structured organization to maintain clean separation of concerns:
|
||||
|
||||
```
|
||||
wp-plugin-starter-template/
|
||||
├── admin/ # Admin-specific functionality
|
||||
│ ├── css/ # Admin stylesheets
|
||||
│ ├── js/ # Admin JavaScript files
|
||||
│ └── lib/ # Admin PHP classes
|
||||
├── assets/ # Frontend assets
|
||||
│ ├── css/ # Frontend stylesheets
|
||||
│ ├── js/ # Frontend JavaScript files
|
||||
│ └── images/ # Images used by the plugin
|
||||
├── includes/ # Core plugin functionality
|
||||
│ ├── core.php # Core functionality class
|
||||
│ └── plugin.php # Main plugin class
|
||||
├── languages/ # Translation files
|
||||
├── tests/ # Test files
|
||||
│ ├── e2e/ # End-to-end tests
|
||||
│ └── unit/ # Unit tests
|
||||
├── .github/ # GitHub-specific files
|
||||
│ └── workflows/ # GitHub Actions workflows
|
||||
├── .ai-workflows/ # AI workflow documentation
|
||||
├── .wiki/ # Wiki documentation
|
||||
└── wp-plugin-starter-template.php # Main plugin file
|
||||
```
|
||||
|
||||
## Core Components
|
||||
|
||||
### Main Plugin File
|
||||
|
||||
The `wp-plugin-starter-template.php` file serves as the entry point for WordPress. It:
|
||||
|
||||
1. Defines plugin metadata
|
||||
2. Prevents direct access
|
||||
3. Loads the main plugin class
|
||||
4. Initializes the plugin
|
||||
|
||||
### Plugin Class
|
||||
|
||||
The `Plugin` class in `includes/plugin.php` is the main controller for the plugin. It:
|
||||
|
||||
1. Initializes core functionality
|
||||
2. Sets up hooks and filters
|
||||
3. Manages plugin activation/deactivation
|
||||
4. Handles plugin updates
|
||||
|
||||
### Core Class
|
||||
|
||||
The `Core` class in `includes/core.php` contains the core functionality of the plugin. It:
|
||||
|
||||
1. Implements the main plugin features
|
||||
2. Provides utility methods
|
||||
3. Manages data processing
|
||||
|
||||
### Admin Class
|
||||
|
||||
The `Admin` class in `admin/lib/admin.php` handles all admin-specific functionality. It:
|
||||
|
||||
1. Creates admin menu pages
|
||||
2. Registers settings
|
||||
3. Enqueues admin assets
|
||||
4. Processes admin form submissions
|
||||
|
||||
## Object-Oriented Approach
|
||||
|
||||
The plugin follows object-oriented programming principles:
|
||||
|
||||
1. **Encapsulation**: Each class encapsulates its own functionality
|
||||
2. **Inheritance**: Classes can extend others to inherit functionality
|
||||
3. **Namespaces**: PHP namespaces are used to avoid conflicts
|
||||
4. **Autoloading**: PSR-4 autoloading for efficient class loading
|
||||
|
||||
## Hook System
|
||||
|
||||
The plugin integrates with WordPress through its hook system:
|
||||
|
||||
1. **Actions**: Used to add functionality at specific points
|
||||
2. **Filters**: Used to modify data before it's used by WordPress
|
||||
|
||||
## Data Flow
|
||||
|
||||
1. WordPress loads the main plugin file
|
||||
2. The Plugin class is instantiated
|
||||
3. The Plugin class initializes the Core class
|
||||
4. The Plugin class initializes the Admin class (in admin context)
|
||||
5. WordPress hooks trigger plugin functionality as needed
|
||||
|
||||
## Extensibility
|
||||
|
||||
The plugin is designed to be extensible:
|
||||
|
||||
1. **Filters**: Key data points can be modified via filters
|
||||
2. **Actions**: Additional functionality can be added via actions
|
||||
3. **Class Structure**: Classes can be extended to add or modify functionality
|
||||
|
||||
## Testing
|
||||
|
||||
The plugin includes a comprehensive testing framework:
|
||||
|
||||
1. **Unit Tests**: For testing individual components
|
||||
2. **End-to-End Tests**: For testing the plugin as a whole
|
||||
|
||||
## Conclusion
|
||||
|
||||
This architecture provides a solid foundation for WordPress plugin development, following best practices and modern coding standards. It's designed to be maintainable, extensible, and easy to understand.
|
||||
+43
-7
@@ -2,12 +2,48 @@
|
||||
|
||||
This page documents all notable changes to the WordPress Plugin Starter Template.
|
||||
|
||||
## Version 0.1.6 (2025-04-19)
|
||||
### Fixed
|
||||
- GitHub Actions workflows permissions for releases and wiki sync
|
||||
|
||||
## Version 0.1.5 (2025-04-19)
|
||||
### Fixed
|
||||
- Release workflow to use correct plugin directory name
|
||||
|
||||
### Added
|
||||
- Testing setup with wp-env and Cypress
|
||||
- Multisite compatibility
|
||||
- npm scripts for development and testing
|
||||
|
||||
## Version 0.1.3 (2025-04-19)
|
||||
### Added
|
||||
- Improved AI IDE context recommendations in documentation
|
||||
- Enhanced Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/
|
||||
|
||||
### Changed
|
||||
- Updated README.md and readme.txt with AI IDE context recommendations
|
||||
- Improved documentation for AI-assisted development
|
||||
- Moved Starter Prompt to the wiki for better organization
|
||||
|
||||
## Version 0.1.2 (2025-04-18)
|
||||
### Added
|
||||
- STARTER-PROMPT.md with comprehensive guide for customizing the template
|
||||
- Additional AI workflow files for better development guidance
|
||||
|
||||
### Changed
|
||||
- Updated documentation files with improved instructions
|
||||
|
||||
## Version 0.1.1 (2025-04-18)
|
||||
### Changed
|
||||
- Updated LICENSE file with correct GPL-2.0 text
|
||||
|
||||
## Version 0.1.0 (2025-04-17)
|
||||
### Added
|
||||
- Initial release with basic template structure
|
||||
- Added core plugin architecture with OOP approach
|
||||
- Added admin interface components and styling
|
||||
- Added update mechanism with multiple source options
|
||||
- Added documentation templates for users and developers
|
||||
- Added AI workflow documentation for AI-assisted development
|
||||
- Added GitHub Actions workflows for automated tasks
|
||||
- Added wiki documentation templates
|
||||
- Core plugin architecture with OOP approach
|
||||
- Admin interface components and styling
|
||||
- Update mechanism with multiple source options
|
||||
- Documentation templates for users and developers
|
||||
- AI workflow documentation for AI-assisted development
|
||||
- GitHub Actions workflows for automated tasks
|
||||
- Wiki documentation templates
|
||||
@@ -0,0 +1,227 @@
|
||||
# Coding Standards
|
||||
|
||||
This document outlines the coding standards used in this plugin. Following these standards ensures consistency, readability, and maintainability of the codebase.
|
||||
|
||||
## PHP Coding Standards
|
||||
|
||||
This plugin follows the [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/) with some additional guidelines.
|
||||
|
||||
### File Structure
|
||||
|
||||
- Each PHP file should begin with the PHP opening tag `<?php` (no closing tag)
|
||||
- Files should use the Unix line endings (LF)
|
||||
- Files should be encoded in UTF-8 without BOM
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
- **Classes**: Use `PascalCase` for class names
|
||||
```php
|
||||
class MyClassName {}
|
||||
```
|
||||
|
||||
- **Methods and Functions**: Use `snake_case` for method and function names
|
||||
```php
|
||||
function my_function_name() {}
|
||||
public function my_method_name() {}
|
||||
```
|
||||
|
||||
- **Variables**: Use `snake_case` for variable names
|
||||
```php
|
||||
$my_variable_name = 'value';
|
||||
```
|
||||
|
||||
- **Constants**: Use `UPPERCASE_WITH_UNDERSCORES` for constants
|
||||
```php
|
||||
define('MY_CONSTANT', 'value');
|
||||
const MY_CLASS_CONSTANT = 'value';
|
||||
```
|
||||
|
||||
- **Namespaces**: Use `PascalCase` for namespace segments
|
||||
```php
|
||||
namespace WPALLSTARS\PluginStarterTemplate;
|
||||
```
|
||||
|
||||
- **Hooks**: Prefix hooks with the plugin's prefix
|
||||
```php
|
||||
do_action('wpst_hook_name');
|
||||
apply_filters('wpst_filter_name', $value);
|
||||
```
|
||||
|
||||
### Indentation and Formatting
|
||||
|
||||
- Use 4 spaces for indentation (not tabs)
|
||||
- Opening braces for classes and functions should be on the same line
|
||||
- Control structures should have one space between the statement and the opening parenthesis
|
||||
- Each line should be no longer than 100 characters
|
||||
|
||||
```php
|
||||
if ($condition) {
|
||||
// Code here
|
||||
} elseif ($another_condition) {
|
||||
// More code
|
||||
} else {
|
||||
// Default code
|
||||
}
|
||||
```
|
||||
|
||||
### Documentation
|
||||
|
||||
- All classes, methods, and functions should be documented using PHPDoc
|
||||
- Include a description, parameters, return values, and exceptions
|
||||
|
||||
```php
|
||||
/**
|
||||
* Short description of the function.
|
||||
*
|
||||
* Longer description if needed.
|
||||
*
|
||||
* @param string $param1 Description of the parameter.
|
||||
* @param int $param2 Description of the parameter.
|
||||
* @return bool Description of the return value.
|
||||
* @throws Exception When something goes wrong.
|
||||
*/
|
||||
function my_function($param1, $param2) {
|
||||
// Function code
|
||||
}
|
||||
```
|
||||
|
||||
### Object-Oriented Programming
|
||||
|
||||
- Each class should have a single responsibility
|
||||
- Use visibility declarations for all properties and methods (public, protected, private)
|
||||
- Use type hints for parameters and return types when possible
|
||||
|
||||
```php
|
||||
class MyClass {
|
||||
/**
|
||||
* Property description.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $property;
|
||||
|
||||
/**
|
||||
* Method description.
|
||||
*
|
||||
* @param string $param Description of the parameter.
|
||||
* @return bool Description of the return value.
|
||||
*/
|
||||
public function my_method(string $param): bool {
|
||||
// Method code
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## JavaScript Coding Standards
|
||||
|
||||
This plugin follows the [WordPress JavaScript Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/javascript/).
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
- **Variables and Functions**: Use `camelCase` for variable and function names
|
||||
```javascript
|
||||
var myVariableName = 'value';
|
||||
function myFunctionName() {}
|
||||
```
|
||||
|
||||
- **Constants**: Use `UPPERCASE_WITH_UNDERSCORES` for constants
|
||||
```javascript
|
||||
var MY_CONSTANT = 'value';
|
||||
```
|
||||
|
||||
### Indentation and Formatting
|
||||
|
||||
- Use 4 spaces for indentation (not tabs)
|
||||
- Opening braces should be on the same line as the statement
|
||||
- Each line should be no longer than 100 characters
|
||||
|
||||
```javascript
|
||||
if (condition) {
|
||||
// Code here
|
||||
} else if (anotherCondition) {
|
||||
// More code
|
||||
} else {
|
||||
// Default code
|
||||
}
|
||||
```
|
||||
|
||||
### Documentation
|
||||
|
||||
- Use JSDoc for documenting functions and objects
|
||||
|
||||
```javascript
|
||||
/**
|
||||
* Short description of the function.
|
||||
*
|
||||
* @param {string} param1 - Description of the parameter.
|
||||
* @param {number} param2 - Description of the parameter.
|
||||
* @returns {boolean} Description of the return value.
|
||||
*/
|
||||
function myFunction(param1, param2) {
|
||||
// Function code
|
||||
}
|
||||
```
|
||||
|
||||
## CSS Coding Standards
|
||||
|
||||
This plugin follows the [WordPress CSS Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/css/).
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
- Use lowercase for selectors
|
||||
- Use hyphens to separate words in class and ID names
|
||||
- Prefix classes and IDs with the plugin's prefix
|
||||
|
||||
```css
|
||||
.wpst-container {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
#wpst-header {
|
||||
padding: 10px;
|
||||
}
|
||||
```
|
||||
|
||||
### Indentation and Formatting
|
||||
|
||||
- Use 4 spaces for indentation (not tabs)
|
||||
- Each property should be on its own line
|
||||
- Include a space after the colon in property declarations
|
||||
- End each declaration with a semicolon
|
||||
- Use single quotes for attribute selectors and property values
|
||||
|
||||
```css
|
||||
.wpst-container {
|
||||
margin: 0;
|
||||
padding: 10px;
|
||||
font-family: 'Helvetica', sans-serif;
|
||||
}
|
||||
```
|
||||
|
||||
## Automated Code Checking
|
||||
|
||||
This plugin uses automated tools to enforce coding standards:
|
||||
|
||||
1. **PHP_CodeSniffer (PHPCS)**: Checks PHP code against the WordPress Coding Standards
|
||||
```bash
|
||||
composer run phpcs
|
||||
```
|
||||
|
||||
2. **PHP Code Beautifier and Fixer (PHPCBF)**: Automatically fixes some coding standard violations
|
||||
```bash
|
||||
composer run phpcbf
|
||||
```
|
||||
|
||||
3. **ESLint**: Checks JavaScript code against the WordPress Coding Standards
|
||||
```bash
|
||||
npm run lint:js
|
||||
```
|
||||
|
||||
4. **Stylelint**: Checks CSS code against the WordPress Coding Standards
|
||||
```bash
|
||||
npm run lint:css
|
||||
```
|
||||
|
||||
## Conclusion
|
||||
|
||||
Following these coding standards ensures that the plugin's code is consistent, readable, and maintainable. All contributors should adhere to these standards when submitting code to the project.
|
||||
@@ -0,0 +1,130 @@
|
||||
# Contributing
|
||||
|
||||
Thank you for considering contributing to this project! This document provides guidelines and instructions for contributing.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
By participating in this project, you agree to abide by our code of conduct:
|
||||
|
||||
- Be respectful and inclusive
|
||||
- Be patient and welcoming
|
||||
- Be considerate
|
||||
- Be collaborative
|
||||
- Be open-minded
|
||||
|
||||
## How to Contribute
|
||||
|
||||
### Reporting Bugs
|
||||
|
||||
If you find a bug, please report it by creating an issue on GitHub:
|
||||
|
||||
1. Go to the [Issues](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/issues) page
|
||||
2. Click "New Issue"
|
||||
3. Select "Bug Report"
|
||||
4. Fill out the template with as much detail as possible
|
||||
5. Submit the issue
|
||||
|
||||
Please include:
|
||||
|
||||
- A clear, descriptive title
|
||||
- Steps to reproduce the bug
|
||||
- Expected behavior
|
||||
- Actual behavior
|
||||
- Screenshots (if applicable)
|
||||
- Your environment (WordPress version, PHP version, browser, etc.)
|
||||
|
||||
### Suggesting Enhancements
|
||||
|
||||
If you have an idea for an enhancement:
|
||||
|
||||
1. Go to the [Issues](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/issues) page
|
||||
2. Click "New Issue"
|
||||
3. Select "Feature Request"
|
||||
4. Fill out the template with as much detail as possible
|
||||
5. Submit the issue
|
||||
|
||||
Please include:
|
||||
|
||||
- A clear, descriptive title
|
||||
- A detailed description of the enhancement
|
||||
- Why this enhancement would be useful
|
||||
- Any relevant examples or mockups
|
||||
|
||||
### Pull Requests
|
||||
|
||||
If you want to contribute code:
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a new branch for your feature or bugfix
|
||||
3. Make your changes
|
||||
4. Run tests to ensure your changes don't break anything
|
||||
5. Submit a pull request
|
||||
|
||||
#### Pull Request Process
|
||||
|
||||
1. Fork the repository on [GitHub](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/) or [Gitea](https://gitea.wpallstars.com/wpallstars/wp-plugin-starter-template-for-ai-coding/)
|
||||
2. Clone your fork: `git clone https://github.com/YOUR-USERNAME/wp-plugin-starter-template-for-ai-coding.git`
|
||||
3. Create your feature branch: `git checkout -b feature/amazing-feature`
|
||||
4. Make your changes
|
||||
5. Commit your changes: `git commit -m 'Add some amazing feature'`
|
||||
6. Push to the branch: `git push origin feature/amazing-feature`
|
||||
7. Submit a pull request
|
||||
|
||||
#### Pull Request Guidelines
|
||||
|
||||
- Follow the coding standards (see [Coding Standards](Coding-Standards))
|
||||
- Write tests for your changes
|
||||
- Update documentation as needed
|
||||
- Keep pull requests focused on a single change
|
||||
- Write a clear, descriptive title and description
|
||||
- Reference any related issues
|
||||
|
||||
## Development Environment
|
||||
|
||||
To set up your development environment:
|
||||
|
||||
1. Clone the repository: `git clone https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding.git`
|
||||
2. Install dependencies: `composer install && npm install`
|
||||
3. Start the development environment: `npm run start`
|
||||
|
||||
### Testing
|
||||
|
||||
Before submitting a pull request, make sure to run the tests:
|
||||
|
||||
- PHP Unit Tests: `npm run test:php`
|
||||
- End-to-End Tests: `npm run test:e2e`
|
||||
- Coding Standards: `npm run lint:php`
|
||||
|
||||
## Documentation
|
||||
|
||||
If you're adding a new feature or changing existing functionality, please update the documentation:
|
||||
|
||||
- Update the README.md file if necessary
|
||||
- Update the readme.txt file if necessary
|
||||
- Update or create wiki pages as needed
|
||||
- Update code comments
|
||||
|
||||
## Community
|
||||
|
||||
Join our community to discuss the project:
|
||||
|
||||
- [GitHub Discussions](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/discussions)
|
||||
- [Gitea Issues](https://gitea.wpallstars.com/wpallstars/wp-plugin-starter-template-for-ai-coding/issues)
|
||||
|
||||
## Recognition
|
||||
|
||||
Contributors will be recognized in the following ways:
|
||||
|
||||
- Added to the contributors list in readme.txt
|
||||
- Mentioned in release notes for significant contributions
|
||||
- Thanked in the Changelog for specific contributions
|
||||
|
||||
## License
|
||||
|
||||
By contributing to this project, you agree that your contributions will be licensed under the project's [GPL-2.0+ License](https://www.gnu.org/licenses/gpl-2.0.html).
|
||||
|
||||
## Questions?
|
||||
|
||||
If you have any questions about contributing, please open an issue or contact the maintainers.
|
||||
|
||||
Thank you for your contributions!
|
||||
@@ -0,0 +1,162 @@
|
||||
# Customization Guide
|
||||
|
||||
This guide provides detailed instructions on how to customize the plugin starter template for your specific needs.
|
||||
|
||||
## Basic Customization
|
||||
|
||||
### Renaming the Plugin
|
||||
|
||||
1. **Main Plugin File**: Rename `wp-plugin-starter-template.php` to match your plugin name (e.g., `my-awesome-plugin.php`)
|
||||
|
||||
2. **Update Plugin Header**: Edit the plugin header in your main plugin file:
|
||||
```php
|
||||
/**
|
||||
* Plugin Name: My Awesome Plugin
|
||||
* Plugin URI: https://www.example.com
|
||||
* Description: A brief description of your plugin
|
||||
* Version: 0.1.0
|
||||
* Author: Your Name
|
||||
* Author URI: https://www.example.com
|
||||
* License: GPL-2.0+
|
||||
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
|
||||
* Text Domain: my-awesome-plugin
|
||||
* Domain Path: /languages
|
||||
*/
|
||||
```
|
||||
|
||||
3. **Update Text Domain**: Change the text domain throughout the codebase from `wp-plugin-starter-template` to your plugin's text domain
|
||||
|
||||
### Updating Namespaces
|
||||
|
||||
1. **Change Namespace**: Update all namespace references from `WPALLSTARS\PluginStarterTemplate` to your own namespace (e.g., `MyCompany\MyAwesomePlugin`)
|
||||
|
||||
2. **Update Autoloading**: Modify the `composer.json` file to reflect your new namespace:
|
||||
```json
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"MyCompany\\MyAwesomePlugin\\": "includes/"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
3. **Run Composer**: After updating the namespace, run `composer dump-autoload` to update the autoloader
|
||||
|
||||
### Customizing Documentation
|
||||
|
||||
1. **README.md**: Update the README.md file with your plugin's information
|
||||
2. **readme.txt**: Update the readme.txt file for WordPress.org compatibility
|
||||
3. **CHANGELOG.md**: Start a fresh changelog for your plugin
|
||||
4. **Wiki Documentation**: Customize the wiki documentation to match your plugin
|
||||
|
||||
## Advanced Customization
|
||||
|
||||
### Adding Custom Functionality
|
||||
|
||||
1. **Core Functionality**: Modify the `includes/core.php` file to implement your core functionality
|
||||
|
||||
2. **Admin Interface**: Customize the `admin/lib/admin.php` file to create your admin interface
|
||||
|
||||
3. **Frontend Features**: Add frontend functionality as needed
|
||||
|
||||
### Customizing Assets
|
||||
|
||||
1. **CSS**: Modify or add stylesheets in the `assets/css/` directory
|
||||
2. **JavaScript**: Customize JavaScript files in the `assets/js/` directory
|
||||
3. **Images**: Add your own images to the `assets/images/` directory
|
||||
|
||||
### Adding Custom Post Types
|
||||
|
||||
If your plugin needs custom post types, add them to the Core class:
|
||||
|
||||
```php
|
||||
public function register_post_types() {
|
||||
register_post_type('my_custom_post', [
|
||||
'labels' => [
|
||||
'name' => __('Custom Posts', 'my-awesome-plugin'),
|
||||
'singular_name' => __('Custom Post', 'my-awesome-plugin'),
|
||||
],
|
||||
'public' => true,
|
||||
'has_archive' => true,
|
||||
'supports' => ['title', 'editor', 'thumbnail'],
|
||||
'menu_icon' => 'dashicons-admin-post',
|
||||
]);
|
||||
}
|
||||
```
|
||||
|
||||
### Adding Custom Taxonomies
|
||||
|
||||
For custom taxonomies, add them to the Core class:
|
||||
|
||||
```php
|
||||
public function register_taxonomies() {
|
||||
register_taxonomy('custom_category', 'my_custom_post', [
|
||||
'labels' => [
|
||||
'name' => __('Custom Categories', 'my-awesome-plugin'),
|
||||
'singular_name' => __('Custom Category', 'my-awesome-plugin'),
|
||||
],
|
||||
'hierarchical' => true,
|
||||
'show_admin_column' => true,
|
||||
]);
|
||||
}
|
||||
```
|
||||
|
||||
### Adding Settings Pages
|
||||
|
||||
To add a settings page, customize the Admin class:
|
||||
|
||||
```php
|
||||
public function add_menu_pages() {
|
||||
add_menu_page(
|
||||
__('My Plugin Settings', 'my-awesome-plugin'),
|
||||
__('My Plugin', 'my-awesome-plugin'),
|
||||
'manage_options',
|
||||
'my-awesome-plugin',
|
||||
[$this, 'render_settings_page'],
|
||||
'dashicons-admin-generic',
|
||||
100
|
||||
);
|
||||
}
|
||||
|
||||
public function render_settings_page() {
|
||||
include plugin_dir_path(__FILE__) . '../templates/settings-page.php';
|
||||
}
|
||||
```
|
||||
|
||||
### Customizing Update Mechanism
|
||||
|
||||
The template includes functionality for updates from different sources. Customize the update source options in the main plugin file:
|
||||
|
||||
```php
|
||||
/**
|
||||
* GitHub Plugin URI: username/repository
|
||||
* GitHub Branch: main
|
||||
* Primary Branch: main
|
||||
* Release Branch: main
|
||||
* Release Asset: true
|
||||
* Requires at least: 5.0
|
||||
* Requires PHP: 7.0
|
||||
* Update URI: https://example.com/plugin-updates
|
||||
*/
|
||||
```
|
||||
|
||||
## Testing Your Customizations
|
||||
|
||||
After making your customizations, it's important to test your plugin:
|
||||
|
||||
1. **Unit Tests**: Update and run the unit tests to ensure your core functionality works correctly
|
||||
2. **End-to-End Tests**: Update and run the end-to-end tests to test the plugin as a whole
|
||||
3. **Manual Testing**: Test your plugin in different WordPress environments
|
||||
|
||||
## Building Your Plugin
|
||||
|
||||
Once you've customized the plugin to your needs, build it for distribution:
|
||||
|
||||
```bash
|
||||
./build.sh {VERSION}
|
||||
```
|
||||
|
||||
This will create a ZIP file that you can install in WordPress or distribute to users.
|
||||
|
||||
## Conclusion
|
||||
|
||||
By following this customization guide, you can transform the plugin starter template into a fully functional plugin that meets your specific needs. Remember to maintain the same level of code quality and documentation as you customize the template.
|
||||
@@ -0,0 +1,190 @@
|
||||
# Extending the Plugin
|
||||
|
||||
This guide explains how to extend the plugin's functionality through various extension points.
|
||||
|
||||
## Extension Points
|
||||
|
||||
The plugin is designed with extensibility in mind, providing several ways to extend or modify its functionality:
|
||||
|
||||
1. **Action Hooks**: Add custom functionality at specific points
|
||||
2. **Filter Hooks**: Modify data or behavior
|
||||
3. **Class Extension**: Extend existing classes to add or modify functionality
|
||||
4. **Template Overrides**: Customize the plugin's output
|
||||
|
||||
## Using Action Hooks
|
||||
|
||||
Action hooks allow you to add custom functionality at specific points in the plugin's execution. Here are some examples:
|
||||
|
||||
### Available Actions
|
||||
|
||||
- `wpst_plugin_init`: Fires when the plugin is initialized
|
||||
- `wpst_before_process`: Fires before the plugin processes data
|
||||
- `wpst_after_process`: Fires after the plugin processes data
|
||||
- `wpst_admin_init`: Fires when the admin functionality is initialized
|
||||
|
||||
### Example: Adding Custom Functionality
|
||||
|
||||
```php
|
||||
add_action('wpst_plugin_init', 'my_custom_init_function');
|
||||
|
||||
function my_custom_init_function() {
|
||||
// Your custom initialization code here
|
||||
}
|
||||
```
|
||||
|
||||
### Example: Adding Custom Admin Functionality
|
||||
|
||||
```php
|
||||
add_action('wpst_admin_init', 'my_custom_admin_function');
|
||||
|
||||
function my_custom_admin_function() {
|
||||
// Your custom admin initialization code here
|
||||
}
|
||||
```
|
||||
|
||||
## Using Filter Hooks
|
||||
|
||||
Filter hooks allow you to modify data or behavior at specific points. Here are some examples:
|
||||
|
||||
### Available Filters
|
||||
|
||||
- `wpst_settings`: Filter the plugin settings
|
||||
- `wpst_process_data`: Filter the data being processed
|
||||
- `wpst_admin_tabs`: Filter the admin tabs
|
||||
- `wpst_display_output`: Filter the output before display
|
||||
|
||||
### Example: Modifying Settings
|
||||
|
||||
```php
|
||||
add_filter('wpst_settings', 'my_custom_settings_filter');
|
||||
|
||||
function my_custom_settings_filter($settings) {
|
||||
// Modify the settings array
|
||||
$settings['custom_option'] = 'custom_value';
|
||||
return $settings;
|
||||
}
|
||||
```
|
||||
|
||||
### Example: Modifying Output
|
||||
|
||||
```php
|
||||
add_filter('wpst_display_output', 'my_custom_output_filter');
|
||||
|
||||
function my_custom_output_filter($output) {
|
||||
// Modify the output
|
||||
$output = str_replace('original', 'modified', $output);
|
||||
return $output;
|
||||
}
|
||||
```
|
||||
|
||||
## Extending Classes
|
||||
|
||||
You can extend the plugin's classes to add or modify functionality.
|
||||
|
||||
### Example: Extending the Core Class
|
||||
|
||||
```php
|
||||
use WPALLSTARS\PluginStarterTemplate\Core;
|
||||
|
||||
class My_Extended_Core extends Core {
|
||||
public function __construct() {
|
||||
parent::__construct();
|
||||
// Add your custom initialization here
|
||||
}
|
||||
|
||||
// Override an existing method
|
||||
public function filter_content($content) {
|
||||
// Modify the content
|
||||
$content = parent::filter_content($content);
|
||||
$content = str_replace('original', 'modified', $content);
|
||||
return $content;
|
||||
}
|
||||
|
||||
// Add a new method
|
||||
public function custom_method() {
|
||||
// Your custom method implementation
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Example: Extending the Admin Class
|
||||
|
||||
```php
|
||||
use WPALLSTARS\PluginStarterTemplate\Admin\Admin;
|
||||
|
||||
class My_Extended_Admin extends Admin {
|
||||
public function __construct($core) {
|
||||
parent::__construct($core);
|
||||
// Add your custom initialization here
|
||||
}
|
||||
|
||||
// Override an existing method
|
||||
public function enqueue_admin_assets($hook) {
|
||||
parent::enqueue_admin_assets($hook);
|
||||
// Add your custom assets
|
||||
wp_enqueue_script(
|
||||
'my-custom-script',
|
||||
plugin_dir_url(__FILE__) . 'js/custom-script.js',
|
||||
['jquery'],
|
||||
'1.0.0',
|
||||
true
|
||||
);
|
||||
}
|
||||
|
||||
// Add a new method
|
||||
public function custom_admin_method() {
|
||||
// Your custom method implementation
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Creating Add-ons
|
||||
|
||||
You can create separate add-on plugins that extend the functionality of the main plugin.
|
||||
|
||||
### Example: Basic Add-on Structure
|
||||
|
||||
```php
|
||||
<?php
|
||||
/**
|
||||
* Plugin Name: My Awesome Add-on
|
||||
* Description: Extends the WordPress Plugin Starter Template with awesome features
|
||||
* Version: 1.0.0
|
||||
* Author: Your Name
|
||||
* License: GPL-2.0+
|
||||
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
|
||||
* Text Domain: my-awesome-addon
|
||||
* Requires: WordPress Plugin Starter Template
|
||||
*/
|
||||
|
||||
// Check if the main plugin is active
|
||||
if (!class_exists('WPALLSTARS\\PluginStarterTemplate\\Plugin')) {
|
||||
add_action('admin_notices', 'my_addon_missing_main_plugin_notice');
|
||||
return;
|
||||
}
|
||||
|
||||
function my_addon_missing_main_plugin_notice() {
|
||||
echo '<div class="error"><p>';
|
||||
echo __('My Awesome Add-on requires the WordPress Plugin Starter Template to be installed and activated.', 'my-awesome-addon');
|
||||
echo '</p></div>';
|
||||
}
|
||||
|
||||
// Initialize the add-on
|
||||
add_action('wpst_plugin_init', 'initialize_my_addon');
|
||||
|
||||
function initialize_my_addon() {
|
||||
// Your add-on initialization code here
|
||||
}
|
||||
```
|
||||
|
||||
## Best Practices for Extensions
|
||||
|
||||
1. **Use Namespaces**: Use PHP namespaces to avoid conflicts with other plugins
|
||||
2. **Follow Coding Standards**: Maintain the same coding standards as the main plugin
|
||||
3. **Document Your Extensions**: Provide clear documentation for your extensions
|
||||
4. **Test Thoroughly**: Test your extensions with different WordPress versions
|
||||
5. **Version Compatibility**: Specify which versions of the main plugin your extension is compatible with
|
||||
|
||||
## Conclusion
|
||||
|
||||
By using these extension points, you can customize and extend the plugin's functionality to meet your specific needs without modifying the core plugin files. This approach ensures that your customizations will continue to work even when the main plugin is updated.
|
||||
@@ -4,6 +4,11 @@ Welcome to the documentation wiki for the WordPress Plugin Starter Template.
|
||||
|
||||
This template provides a solid foundation for developing WordPress plugins with best practices for AI-assisted development.
|
||||
|
||||
## Latest Updates
|
||||
|
||||
- Version 0.1.6: Fixed GitHub Actions workflows permissions for releases and wiki sync
|
||||
- Version 0.1.5: Added testing setup with wp-env and Cypress, multisite compatibility
|
||||
|
||||
## Quick Links
|
||||
|
||||
- [Starter Prompt](Starter-Prompt)
|
||||
|
||||
@@ -0,0 +1,180 @@
|
||||
# Release Process
|
||||
|
||||
This document outlines the process for creating and publishing new releases of the plugin.
|
||||
|
||||
## Version Numbering
|
||||
|
||||
This plugin follows [Semantic Versioning](https://semver.org/) (SemVer):
|
||||
|
||||
- **MAJOR version** (x.0.0): Incompatible API changes
|
||||
- **MINOR version** (0.x.0): Add functionality in a backward-compatible manner
|
||||
- **PATCH version** (0.0.x): Backward-compatible bug fixes
|
||||
|
||||
## Pre-Release Checklist
|
||||
|
||||
Before creating a new release, complete the following checklist:
|
||||
|
||||
1. **Code Review**: Ensure all code has been reviewed and approved
|
||||
2. **Testing**: Verify that all tests pass
|
||||
- Unit tests
|
||||
- End-to-end tests
|
||||
- Manual testing in different environments
|
||||
3. **Documentation**: Update all relevant documentation
|
||||
- README.md
|
||||
- readme.txt
|
||||
- Wiki pages
|
||||
- Code comments
|
||||
4. **Changelog**: Update CHANGELOG.md with all changes since the last release
|
||||
5. **Version Numbers**: Update version numbers in:
|
||||
- Main plugin file header
|
||||
- Plugin initialization
|
||||
- readme.txt
|
||||
- package.json (if applicable)
|
||||
- composer.json (if applicable)
|
||||
|
||||
## Creating a Release
|
||||
|
||||
### Manual Release Process
|
||||
|
||||
1. **Create a Release Branch**:
|
||||
```bash
|
||||
git checkout -b release/x.y.z
|
||||
```
|
||||
|
||||
2. **Update Version Numbers**:
|
||||
- Update the version number in the main plugin file header
|
||||
- Update the version number in the plugin initialization
|
||||
- Update the "Stable tag" in readme.txt
|
||||
- Update the version in package.json and composer.json (if applicable)
|
||||
|
||||
3. **Update Changelog**:
|
||||
- Add a new section to CHANGELOG.md for the new version
|
||||
- Add a new section to the Changelog in readme.txt
|
||||
- Add a new section to the Upgrade Notice in readme.txt
|
||||
|
||||
4. **Commit Changes**:
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Bump version to x.y.z"
|
||||
```
|
||||
|
||||
5. **Create a Pull Request**:
|
||||
- Push the release branch to GitHub
|
||||
- Create a pull request against the main branch
|
||||
- Have the pull request reviewed and approved
|
||||
|
||||
6. **Merge the Pull Request**:
|
||||
- Merge the pull request into the main branch
|
||||
|
||||
7. **Create a Release Tag**:
|
||||
```bash
|
||||
git checkout main
|
||||
git pull
|
||||
git tag -a vx.y.z -m "Version x.y.z"
|
||||
git push origin vx.y.z
|
||||
```
|
||||
|
||||
8. **Create a GitHub Release**:
|
||||
- Go to the GitHub repository
|
||||
- Click on "Releases"
|
||||
- Click "Draft a new release"
|
||||
- Select the tag you just created
|
||||
- Add a title and description
|
||||
- Upload the built plugin ZIP file
|
||||
- Publish the release
|
||||
|
||||
### Automated Release Process
|
||||
|
||||
This plugin uses GitHub Actions to automate the release process:
|
||||
|
||||
1. **Create a Release Branch**:
|
||||
```bash
|
||||
git checkout -b release/x.y.z
|
||||
```
|
||||
|
||||
2. **Update Version Numbers and Changelog** (as described above)
|
||||
|
||||
3. **Commit Changes**:
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Bump version to x.y.z"
|
||||
```
|
||||
|
||||
4. **Create a Pull Request** (as described above)
|
||||
|
||||
5. **Merge the Pull Request** (as described above)
|
||||
|
||||
6. **Create a Release Tag**:
|
||||
```bash
|
||||
git checkout main
|
||||
git pull
|
||||
git tag -a vx.y.z -m "Version x.y.z"
|
||||
git push origin vx.y.z
|
||||
```
|
||||
|
||||
7. **Automated GitHub Release**:
|
||||
- The GitHub Actions workflow will automatically:
|
||||
- Build the plugin
|
||||
- Create a GitHub release
|
||||
- Upload the built plugin ZIP file
|
||||
- Update the wiki (if configured)
|
||||
|
||||
## Post-Release Tasks
|
||||
|
||||
After creating a release, complete the following tasks:
|
||||
|
||||
1. **Verify the Release**:
|
||||
- Check that the GitHub release was created successfully
|
||||
- Download the ZIP file and verify its contents
|
||||
- Test the plugin by installing it from the ZIP file
|
||||
|
||||
2. **Update Documentation**:
|
||||
- Update any external documentation that references the plugin version
|
||||
- Update the plugin's website (if applicable)
|
||||
|
||||
3. **Announce the Release**:
|
||||
- Announce the release on relevant channels (blog, social media, etc.)
|
||||
- Notify users who have reported issues that are fixed in this release
|
||||
|
||||
4. **Start Planning the Next Release**:
|
||||
- Create issues for the next release
|
||||
- Update the project roadmap
|
||||
|
||||
## Hotfix Process
|
||||
|
||||
For critical bugs that need to be fixed immediately:
|
||||
|
||||
1. **Create a Hotfix Branch**:
|
||||
```bash
|
||||
git checkout -b hotfix/x.y.z
|
||||
```
|
||||
|
||||
2. **Fix the Bug**:
|
||||
- Make the necessary changes to fix the bug
|
||||
- Add tests to prevent regression
|
||||
|
||||
3. **Update Version Numbers and Changelog** (as described above)
|
||||
|
||||
4. **Commit Changes**:
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Hotfix: description of the fix"
|
||||
```
|
||||
|
||||
5. **Create a Pull Request** (as described above)
|
||||
|
||||
6. **Merge the Pull Request** (as described above)
|
||||
|
||||
7. **Create a Release Tag and GitHub Release** (as described above)
|
||||
|
||||
## Release Branches
|
||||
|
||||
This plugin uses the following branch strategy:
|
||||
|
||||
- **main**: The main development branch
|
||||
- **release/x.y.z**: Temporary branches for preparing releases
|
||||
- **hotfix/x.y.z**: Temporary branches for hotfixes
|
||||
|
||||
## Conclusion
|
||||
|
||||
Following this release process ensures that releases are consistent, well-documented, and properly tested. It also helps users understand what has changed between versions and how to upgrade safely.
|
||||
@@ -0,0 +1,168 @@
|
||||
# Troubleshooting
|
||||
|
||||
This guide provides solutions to common issues you might encounter when using or developing with this plugin.
|
||||
|
||||
## Installation Issues
|
||||
|
||||
### Plugin Installation Fails
|
||||
|
||||
**Problem**: The plugin fails to install in WordPress.
|
||||
|
||||
**Solutions**:
|
||||
1. Verify that your WordPress version meets the minimum requirement (5.0+)
|
||||
2. Check that your PHP version meets the minimum requirement (7.0+)
|
||||
3. Ensure the ZIP file is properly formatted and contains all required files
|
||||
4. Try installing the plugin manually by uploading the unzipped folder to the `wp-content/plugins` directory
|
||||
|
||||
### Activation Error
|
||||
|
||||
**Problem**: You receive an error when activating the plugin.
|
||||
|
||||
**Solutions**:
|
||||
1. Check the error message for specific details
|
||||
2. Verify that all plugin dependencies are installed and activated
|
||||
3. Check your server's error logs for more information
|
||||
4. Temporarily deactivate other plugins to check for conflicts
|
||||
|
||||
## Development Issues
|
||||
|
||||
### Composer Dependencies
|
||||
|
||||
**Problem**: Composer fails to install dependencies.
|
||||
|
||||
**Solutions**:
|
||||
1. Verify that you have Composer installed and up to date
|
||||
2. Check that your PHP version meets the requirements for all dependencies
|
||||
3. Try clearing Composer's cache: `composer clear-cache`
|
||||
4. Run `composer install --verbose` to see detailed error messages
|
||||
|
||||
### NPM Dependencies
|
||||
|
||||
**Problem**: NPM fails to install dependencies.
|
||||
|
||||
**Solutions**:
|
||||
1. Verify that you have Node.js and NPM installed and up to date
|
||||
2. Try clearing NPM's cache: `npm cache clean --force`
|
||||
3. Delete the `node_modules` directory and run `npm install` again
|
||||
4. Run `npm install --verbose` to see detailed error messages
|
||||
|
||||
### WordPress Environment (wp-env)
|
||||
|
||||
**Problem**: The WordPress environment fails to start.
|
||||
|
||||
**Solutions**:
|
||||
1. Verify that Docker is installed and running
|
||||
2. Check that the Docker daemon has enough resources allocated
|
||||
3. Try stopping and removing existing containers: `npm run wp-env stop && npm run wp-env clean`
|
||||
4. Run `npm run wp-env start --debug` to see detailed error messages
|
||||
|
||||
### Unit Tests
|
||||
|
||||
**Problem**: Unit tests are failing.
|
||||
|
||||
**Solutions**:
|
||||
1. Verify that you have PHPUnit installed and configured correctly
|
||||
2. Check that all dependencies are installed: `composer install`
|
||||
3. Run tests with verbose output: `./vendor/bin/phpunit --verbose`
|
||||
4. Check for syntax errors in your PHP files
|
||||
|
||||
### End-to-End Tests
|
||||
|
||||
**Problem**: End-to-end tests are failing.
|
||||
|
||||
**Solutions**:
|
||||
1. Verify that the WordPress environment is running: `npm run start`
|
||||
2. Check that Cypress is installed correctly: `npx cypress verify`
|
||||
3. Run tests in interactive mode to debug: `npm run test:e2e`
|
||||
4. Check for issues with selectors or timing in your test scripts
|
||||
|
||||
## Plugin Functionality Issues
|
||||
|
||||
### Plugin Settings Not Saving
|
||||
|
||||
**Problem**: Changes to plugin settings are not being saved.
|
||||
|
||||
**Solutions**:
|
||||
1. Check for JavaScript errors in the browser console
|
||||
2. Verify that the settings form is submitting correctly
|
||||
3. Check that the WordPress nonce is being verified correctly
|
||||
4. Ensure that the user has the necessary permissions to save settings
|
||||
|
||||
### Plugin Conflicts
|
||||
|
||||
**Problem**: The plugin conflicts with other plugins.
|
||||
|
||||
**Solutions**:
|
||||
1. Deactivate other plugins one by one to identify the conflict
|
||||
2. Check for JavaScript errors in the browser console
|
||||
3. Check for PHP errors in the server logs
|
||||
4. Contact the developers of both plugins to report the conflict
|
||||
|
||||
### Performance Issues
|
||||
|
||||
**Problem**: The plugin is causing performance issues.
|
||||
|
||||
**Solutions**:
|
||||
1. Check if the plugin is making excessive database queries
|
||||
2. Verify that assets (CSS/JS) are being properly enqueued and minified
|
||||
3. Consider implementing caching for resource-intensive operations
|
||||
4. Use a profiling tool to identify bottlenecks
|
||||
|
||||
## Update Issues
|
||||
|
||||
### Update Fails
|
||||
|
||||
**Problem**: The plugin fails to update.
|
||||
|
||||
**Solutions**:
|
||||
1. Verify that your WordPress version meets the requirements for the new version
|
||||
2. Check that your PHP version meets the requirements for the new version
|
||||
3. Try updating manually by downloading the new version and replacing the old files
|
||||
4. Check for file permission issues on your server
|
||||
|
||||
### Lost Settings After Update
|
||||
|
||||
**Problem**: Plugin settings are lost after updating.
|
||||
|
||||
**Solutions**:
|
||||
1. Check if the plugin includes a data migration process for updates
|
||||
2. Verify that the settings are being stored in the database correctly
|
||||
3. Restore settings from a backup if available
|
||||
4. Contact plugin support for assistance
|
||||
|
||||
## Multisite Issues
|
||||
|
||||
### Plugin Not Working on Multisite
|
||||
|
||||
**Problem**: The plugin doesn't work correctly on a multisite installation.
|
||||
|
||||
**Solutions**:
|
||||
1. Verify that the plugin is network activated if required
|
||||
2. Check that the plugin is compatible with multisite (it should be!)
|
||||
3. Ensure that the plugin has the necessary permissions on each site
|
||||
4. Check for multisite-specific settings or options
|
||||
|
||||
## Getting Additional Help
|
||||
|
||||
If you're still experiencing issues after trying these troubleshooting steps:
|
||||
|
||||
1. Check the [Frequently Asked Questions](Frequently-Asked-Questions) for more information
|
||||
2. Search for similar issues in the [GitHub Issues](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/issues)
|
||||
3. Create a new issue with detailed information about your problem
|
||||
4. Contact the plugin developers for direct support
|
||||
|
||||
## Reporting Bugs
|
||||
|
||||
If you've identified a bug in the plugin:
|
||||
|
||||
1. Go to the [GitHub Issues](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/issues) page
|
||||
2. Click "New Issue"
|
||||
3. Select "Bug Report"
|
||||
4. Fill out the template with as much detail as possible
|
||||
5. Submit the issue
|
||||
|
||||
Please include:
|
||||
- A clear description of the bug
|
||||
- Steps to reproduce the issue
|
||||
- Your environment details (WordPress version, PHP version, etc.)
|
||||
- Any relevant error messages or screenshots
|
||||
@@ -1,5 +1,6 @@
|
||||
## User Documentation
|
||||
* [Home](Home)
|
||||
* [Starter Prompt](Starter-Prompt)
|
||||
* [Installation Guide](Installation-Guide)
|
||||
* [Usage Instructions](Usage-Instructions)
|
||||
* [Frequently Asked Questions](Frequently-Asked-Questions)
|
||||
|
||||
+22
-1
@@ -1,13 +1,34 @@
|
||||
All notable changes to this project should be documented both here and in the main Readme files.
|
||||
|
||||
#### [0.1.7] - 2025-04-19
|
||||
#### Fixed
|
||||
- GitHub Actions tests workflow with proper file paths and dependencies
|
||||
|
||||
#### Improved
|
||||
- Workflow names for better clarity in GitHub Actions UI
|
||||
|
||||
#### [0.1.6] - 2025-04-19
|
||||
#### Fixed
|
||||
- GitHub Actions workflows permissions for releases and wiki sync
|
||||
|
||||
#### [0.1.5] - 2025-04-19
|
||||
#### Fixed
|
||||
- Release workflow to use correct plugin directory name
|
||||
|
||||
#### Added
|
||||
- Testing setup with wp-env and Cypress
|
||||
- Multisite compatibility
|
||||
- npm scripts for development and testing
|
||||
|
||||
#### [0.1.3] - 2025-04-19
|
||||
#### Added
|
||||
- Improved AI IDE context recommendations in documentation
|
||||
- Enhanced STARTER-PROMPT.md with guidance on pinning .ai-assistant.md and .ai-workflows/
|
||||
- Enhanced Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/
|
||||
|
||||
#### Changed
|
||||
- Updated README.md and readme.txt with AI IDE context recommendations
|
||||
- Improved documentation for AI-assisted development
|
||||
- Moved Starter Prompt to the wiki for better organization
|
||||
|
||||
#### [0.1.2] - 2025-04-18
|
||||
#### Added
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# WordPress Plugin Starter Template
|
||||
# WordPress Plugin Starter Template for AI Coding
|
||||
|
||||
[](https://www.gnu.org/licenses/gpl-2.0.html)
|
||||
|
||||
@@ -15,18 +15,19 @@ This template is based on the experience gained from developing the "Fix 'Plugin
|
||||
* **Object-Oriented Architecture**: Well-structured, maintainable code using OOP principles
|
||||
* **Namespace Support**: Modern PHP namespacing for better organization and avoiding conflicts
|
||||
* **Comprehensive Documentation**: Detailed documentation for both users and developers
|
||||
* **Testing Framework**: PHPUnit setup for unit testing
|
||||
* **Testing Framework**: PHPUnit setup for unit testing and Cypress for e2e testing
|
||||
* **Internationalization Ready**: Full support for translation and localization
|
||||
* **Update Source Selection**: Choose between WordPress.org, GitHub, or Gitea for plugin updates
|
||||
* **AI Workflow Documentation**: Detailed guides for AI-assisted development
|
||||
* **Wiki Documentation**: Ready-to-use wiki structure for comprehensive documentation
|
||||
* **Multisite Compatible**: Fully tested and compatible with WordPress multisite installations
|
||||
|
||||
### How to Use This Template
|
||||
|
||||
1. Clone or download this repository
|
||||
2. **Important**: Begin by reading the [STARTER-PROMPT.md](STARTER-PROMPT.md) file for detailed instructions
|
||||
2. **Important**: Begin by reading the [Starter Prompt](.wiki/Starter-Prompt.md) file for detailed instructions
|
||||
3. Add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context (pin them if possible)
|
||||
4. Use the prompt in STARTER-PROMPT.md to guide the AI in customizing the template for your plugin
|
||||
4. Use the prompt in the Starter Prompt file to guide the AI in customizing the template for your plugin
|
||||
5. Rename files and update namespaces to match your plugin
|
||||
6. Customize the functionality for your specific needs
|
||||
7. Update documentation to reflect your plugin's features
|
||||
@@ -38,16 +39,16 @@ This template includes comprehensive documentation for AI-assisted development:
|
||||
|
||||
* **.ai-assistant.md**: Guide for AI assistants to understand the project structure
|
||||
* **.ai-workflows/**: Detailed workflow documentation for common development tasks
|
||||
* **STARTER-PROMPT.md**: Comprehensive prompt for AI tools to help customize the template
|
||||
* **Starter Prompt**: Comprehensive prompt for AI tools to help customize the template (available in the [wiki](.wiki/Starter-Prompt.md))
|
||||
|
||||
**Important**: For the best AI assistance, add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message.
|
||||
|
||||
## Installation
|
||||
|
||||
1. Clone or download this repository
|
||||
2. Read the [STARTER-PROMPT.md](STARTER-PROMPT.md) file for detailed instructions
|
||||
2. Read the [Starter Prompt](.wiki/Starter-Prompt.md) file for detailed instructions
|
||||
3. Add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context
|
||||
4. Use the prompt in STARTER-PROMPT.md to guide the AI in customizing the template
|
||||
4. Use the prompt in the Starter Prompt file to guide the AI in customizing the template
|
||||
5. Rename files and update namespaces to match your plugin
|
||||
6. Customize the functionality for your specific needs
|
||||
7. Update documentation to reflect your plugin's features
|
||||
@@ -59,16 +60,96 @@ This template includes comprehensive documentation for AI-assisted development:
|
||||
|
||||
To get started with this template, follow these steps:
|
||||
|
||||
1. Clone this repository to your local machine:
|
||||
1. In your terminal, navigate to the folder you keep you Git repositories (eg: `~/Git/`), then clone this repository to your local machine:
|
||||
```bash
|
||||
git clone https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding.git
|
||||
```
|
||||
|
||||
2. Open the STARTER-PROMPT.md file and follow the instructions to customize the template for your plugin.
|
||||
2. Open the [Starter Prompt](.wiki/Starter-Prompt.md) file and follow the instructions to customize the template for your plugin.
|
||||
|
||||
3. Add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context.
|
||||
|
||||
4. Use an AI assistant like GitHub Copilot, Claude, or ChatGPT to help you customize the template by providing the prompt from STARTER-PROMPT.md.
|
||||
4. Use an AI assistant like GitHub Copilot, Claude, or ChatGPT to help you customize the template by providing the prompt from the Starter Prompt file.
|
||||
|
||||
### Development Environment
|
||||
|
||||
This template includes configuration for WordPress Environment (wp-env) to make local development easier:
|
||||
|
||||
1. Install Node.js dependencies:
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
2. Start the WordPress environment:
|
||||
```bash
|
||||
npm run start
|
||||
```
|
||||
|
||||
3. For multisite testing:
|
||||
```bash
|
||||
npm run multisite
|
||||
```
|
||||
|
||||
4. Access your local WordPress site at http://localhost:8888 (admin credentials: admin/password)
|
||||
|
||||
### Testing
|
||||
|
||||
The template includes both PHP unit tests and end-to-end tests:
|
||||
|
||||
#### PHP Unit Tests
|
||||
|
||||
1. Install Composer dependencies:
|
||||
```bash
|
||||
composer install
|
||||
```
|
||||
|
||||
2. Run PHP unit tests:
|
||||
```bash
|
||||
npm run test:php
|
||||
```
|
||||
|
||||
3. Check PHP coding standards:
|
||||
```bash
|
||||
npm run lint:php
|
||||
```
|
||||
|
||||
4. Fix PHP coding standards issues:
|
||||
```bash
|
||||
npm run fix:php
|
||||
```
|
||||
|
||||
#### End-to-End Tests
|
||||
|
||||
1. Start the WordPress environment:
|
||||
```bash
|
||||
npm run start
|
||||
```
|
||||
|
||||
2. Run Cypress tests in interactive mode:
|
||||
```bash
|
||||
npm run test:e2e
|
||||
```
|
||||
|
||||
3. Run Cypress tests in headless mode:
|
||||
```bash
|
||||
npm run test:e2e:headless
|
||||
```
|
||||
|
||||
### Building for Production
|
||||
|
||||
Use the included build script to create a deployable version of your plugin:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
Or directly:
|
||||
|
||||
```bash
|
||||
./build.sh {VERSION}
|
||||
```
|
||||
|
||||
This will create a ZIP file that you can install in WordPress.
|
||||
|
||||
### Using with Git Updater
|
||||
|
||||
@@ -95,7 +176,7 @@ This template includes functionality that allows users to choose where they want
|
||||
|
||||
### How do I customize this template for my plugin?
|
||||
|
||||
See the [STARTER-PROMPT.md](STARTER-PROMPT.md) file for detailed instructions on customizing this template for your specific plugin needs. Make sure to add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context for the best results.
|
||||
See the [Starter Prompt](.wiki/Starter-Prompt.md) file for detailed instructions on customizing this template for your specific plugin needs. Make sure to add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context for the best results.
|
||||
|
||||
### What files do I need to update with my plugin information?
|
||||
|
||||
@@ -105,13 +186,14 @@ The main files you need to update include:
|
||||
3. readme.txt
|
||||
4. CHANGELOG.md
|
||||
5. composer.json
|
||||
6. languages/pot file
|
||||
7. .github/workflows/
|
||||
8. .wiki/
|
||||
9. .ai-assistant.md
|
||||
10. includes/plugin.php
|
||||
11. includes/core.php
|
||||
12. admin/lib/admin.php
|
||||
6. package.json
|
||||
7. languages/pot file
|
||||
8. .github/workflows/
|
||||
9. .wiki/
|
||||
10. .ai-assistant.md
|
||||
11. includes/plugin.php
|
||||
12. includes/core.php
|
||||
13. admin/lib/admin.php
|
||||
|
||||
### How do I build and test my plugin?
|
||||
|
||||
@@ -127,6 +209,14 @@ This will create a ZIP file that you can install in WordPress.
|
||||
|
||||
Customize the includes/core.php file to implement your core functionality and the admin/lib/admin.php file for admin-specific functionality.
|
||||
|
||||
### Is this template compatible with WordPress multisite?
|
||||
|
||||
Yes, this template is fully compatible with WordPress multisite installations. You can test multisite compatibility by running:
|
||||
|
||||
```bash
|
||||
npm run multisite
|
||||
```
|
||||
|
||||
## Support & Feedback
|
||||
|
||||
If you need help with this template, there are several ways to get support:
|
||||
@@ -188,9 +278,19 @@ For more information on Git Updater integration, see the [Git Updater Required H
|
||||
|
||||
## Changelog
|
||||
|
||||
### 0.1.6
|
||||
* Fixed: GitHub Actions workflows permissions for releases and wiki sync
|
||||
|
||||
### 0.1.5
|
||||
* Fixed: Release workflow to use correct plugin directory name
|
||||
* Added: Testing setup with wp-env and Cypress
|
||||
* Added: Multisite compatibility
|
||||
* Added: npm scripts for development and testing
|
||||
|
||||
### 0.1.3
|
||||
* Added: Improved AI IDE context recommendations in documentation
|
||||
* Enhanced: STARTER-PROMPT.md with guidance on pinning .ai-assistant.md and .ai-workflows/
|
||||
* Enhanced: Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/
|
||||
* Moved: Starter Prompt to the wiki for better organization
|
||||
* Updated: README.md and readme.txt with AI IDE context recommendations
|
||||
* Improved: Documentation for AI-assisted development
|
||||
|
||||
|
||||
+72
-72
@@ -6,140 +6,140 @@
|
||||
|
||||
/* General Admin Styles */
|
||||
.wpst-admin-page {
|
||||
max-width: 1200px;
|
||||
margin: 20px auto;
|
||||
padding: 20px;
|
||||
background: #fff;
|
||||
border-radius: 5px;
|
||||
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
|
||||
max-width: 1200px;
|
||||
margin: 20px auto;
|
||||
padding: 20px;
|
||||
background: #fff;
|
||||
border-radius: 5px;
|
||||
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
.wpst-admin-header {
|
||||
margin-bottom: 20px;
|
||||
padding-bottom: 20px;
|
||||
border-bottom: 1px solid #eee;
|
||||
margin-bottom: 20px;
|
||||
padding-bottom: 20px;
|
||||
border-bottom: 1px solid #eee;
|
||||
}
|
||||
|
||||
.wpst-admin-header h1 {
|
||||
margin-top: 0;
|
||||
color: #23282d;
|
||||
margin-top: 0;
|
||||
color: #23282d;
|
||||
}
|
||||
|
||||
/* Admin Form Styles */
|
||||
.wpst-form-table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
.wpst-form-table th {
|
||||
text-align: left;
|
||||
padding: 15px 10px 15px 0;
|
||||
width: 200px;
|
||||
vertical-align: top;
|
||||
text-align: left;
|
||||
padding: 15px 10px 15px 0;
|
||||
width: 200px;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
.wpst-form-table td {
|
||||
padding: 15px 0;
|
||||
vertical-align: middle;
|
||||
padding: 15px 0;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
.wpst-form-table input[type="text"],
|
||||
.wpst-form-table input[type="number"],
|
||||
.wpst-form-table select,
|
||||
.wpst-form-table textarea {
|
||||
width: 400px;
|
||||
max-width: 100%;
|
||||
width: 400px;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.wpst-form-table textarea {
|
||||
min-height: 100px;
|
||||
min-height: 100px;
|
||||
}
|
||||
|
||||
.wpst-form-description {
|
||||
color: #666;
|
||||
font-style: italic;
|
||||
margin-top: 5px;
|
||||
color: #666;
|
||||
font-style: italic;
|
||||
margin-top: 5px;
|
||||
}
|
||||
|
||||
/* Admin Notices */
|
||||
.wpst-notice {
|
||||
padding: 10px 15px;
|
||||
margin: 15px 0;
|
||||
border-radius: 3px;
|
||||
border-left: 4px solid #00a0d2;
|
||||
background: #f7fcff;
|
||||
padding: 10px 15px;
|
||||
margin: 15px 0;
|
||||
border-radius: 3px;
|
||||
border-left: 4px solid #00a0d2;
|
||||
background: #f7fcff;
|
||||
}
|
||||
|
||||
.wpst-notice.success {
|
||||
border-left-color: #46b450;
|
||||
background: #ecf7ed;
|
||||
border-left-color: #46b450;
|
||||
background: #ecf7ed;
|
||||
}
|
||||
|
||||
.wpst-notice.error {
|
||||
border-left-color: #dc3232;
|
||||
background: #fbeaea;
|
||||
border-left-color: #dc3232;
|
||||
background: #fbeaea;
|
||||
}
|
||||
|
||||
.wpst-notice.warning {
|
||||
border-left-color: #ffb900;
|
||||
background: #fff8e5;
|
||||
border-left-color: #ffb900;
|
||||
background: #fff8e5;
|
||||
}
|
||||
|
||||
/* Admin Cards */
|
||||
.wpst-card-container {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
margin: 0 -10px;
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
margin: 0 -10px;
|
||||
}
|
||||
|
||||
.wpst-card {
|
||||
flex: 1 0 300px;
|
||||
margin: 10px;
|
||||
padding: 20px;
|
||||
background: #fff;
|
||||
border-radius: 3px;
|
||||
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
|
||||
flex: 1 0 300px;
|
||||
margin: 10px;
|
||||
padding: 20px;
|
||||
background: #fff;
|
||||
border-radius: 3px;
|
||||
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
.wpst-card-header {
|
||||
margin-bottom: 15px;
|
||||
padding-bottom: 15px;
|
||||
border-bottom: 1px solid #eee;
|
||||
margin-bottom: 15px;
|
||||
padding-bottom: 15px;
|
||||
border-bottom: 1px solid #eee;
|
||||
}
|
||||
|
||||
.wpst-card-title {
|
||||
margin: 0;
|
||||
font-size: 16px;
|
||||
font-weight: 600;
|
||||
margin: 0;
|
||||
font-size: 16px;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.wpst-card-content {
|
||||
margin-bottom: 15px;
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
.wpst-card-footer {
|
||||
padding-top: 15px;
|
||||
border-top: 1px solid #eee;
|
||||
text-align: right;
|
||||
padding-top: 15px;
|
||||
border-top: 1px solid #eee;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
/* Responsive Styles */
|
||||
@media screen and (max-width: 782px) {
|
||||
.wpst-form-table th {
|
||||
width: 100%;
|
||||
display: block;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
.wpst-form-table td {
|
||||
width: 100%;
|
||||
display: block;
|
||||
}
|
||||
|
||||
.wpst-form-table input[type="text"],
|
||||
.wpst-form-table input[type="number"],
|
||||
.wpst-form-table select,
|
||||
.wpst-form-table textarea {
|
||||
width: 100%;
|
||||
}
|
||||
.wpst-form-table th {
|
||||
width: 100%;
|
||||
display: block;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
.wpst-form-table td {
|
||||
width: 100%;
|
||||
display: block;
|
||||
}
|
||||
|
||||
.wpst-form-table input[type="text"],
|
||||
.wpst-form-table input[type="number"],
|
||||
.wpst-form-table select,
|
||||
.wpst-form-table textarea {
|
||||
width: 100%;
|
||||
}
|
||||
}
|
||||
@@ -6,138 +6,138 @@
|
||||
|
||||
/* Modal Styles */
|
||||
.wpst-modal {
|
||||
display: none;
|
||||
position: fixed;
|
||||
z-index: 100000;
|
||||
left: 0;
|
||||
top: 0;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
overflow: auto;
|
||||
background-color: rgba(0, 0, 0, 0.4);
|
||||
display: none;
|
||||
position: fixed;
|
||||
z-index: 100000;
|
||||
left: 0;
|
||||
top: 0;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
overflow: auto;
|
||||
background-color: rgba(0, 0, 0, 0.4);
|
||||
}
|
||||
|
||||
.wpst-modal-content {
|
||||
position: relative;
|
||||
background-color: #fefefe;
|
||||
margin: 10% auto;
|
||||
padding: 20px;
|
||||
border-radius: 5px;
|
||||
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);
|
||||
width: 500px;
|
||||
max-width: 90%;
|
||||
position: relative;
|
||||
background-color: #fefefe;
|
||||
margin: 10% auto;
|
||||
padding: 20px;
|
||||
border-radius: 5px;
|
||||
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);
|
||||
width: 500px;
|
||||
max-width: 90%;
|
||||
}
|
||||
|
||||
.wpst-modal-header {
|
||||
padding-bottom: 15px;
|
||||
border-bottom: 1px solid #eee;
|
||||
margin-bottom: 15px;
|
||||
padding-bottom: 15px;
|
||||
border-bottom: 1px solid #eee;
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
.wpst-modal-title {
|
||||
margin: 0;
|
||||
font-size: 18px;
|
||||
font-weight: 600;
|
||||
margin: 0;
|
||||
font-size: 18px;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.wpst-modal-close {
|
||||
position: absolute;
|
||||
top: 10px;
|
||||
right: 15px;
|
||||
font-size: 20px;
|
||||
font-weight: bold;
|
||||
color: #666;
|
||||
cursor: pointer;
|
||||
position: absolute;
|
||||
top: 10px;
|
||||
right: 15px;
|
||||
font-size: 20px;
|
||||
font-weight: bold;
|
||||
color: #666;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.wpst-modal-close:hover,
|
||||
.wpst-modal-close:focus {
|
||||
color: #000;
|
||||
text-decoration: none;
|
||||
color: #000;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.wpst-modal-body {
|
||||
margin-bottom: 20px;
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
|
||||
.wpst-modal-footer {
|
||||
padding-top: 15px;
|
||||
border-top: 1px solid #eee;
|
||||
text-align: right;
|
||||
padding-top: 15px;
|
||||
border-top: 1px solid #eee;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
/* Source Selection Styles */
|
||||
.wpst-source-options {
|
||||
margin: 15px 0;
|
||||
margin: 15px 0;
|
||||
}
|
||||
|
||||
.wpst-source-option {
|
||||
display: block;
|
||||
margin-bottom: 10px;
|
||||
padding: 10px;
|
||||
border: 1px solid #ddd;
|
||||
border-radius: 3px;
|
||||
cursor: pointer;
|
||||
display: block;
|
||||
margin-bottom: 10px;
|
||||
padding: 10px;
|
||||
border: 1px solid #ddd;
|
||||
border-radius: 3px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.wpst-source-option:hover {
|
||||
background-color: #f9f9f9;
|
||||
background-color: #f9f9f9;
|
||||
}
|
||||
|
||||
.wpst-source-option.selected {
|
||||
border-color: #0073aa;
|
||||
background-color: #f0f6fc;
|
||||
border-color: #0073aa;
|
||||
background-color: #f0f6fc;
|
||||
}
|
||||
|
||||
.wpst-source-option input[type="radio"] {
|
||||
margin-right: 10px;
|
||||
margin-right: 10px;
|
||||
}
|
||||
|
||||
.wpst-source-option-label {
|
||||
font-weight: 600;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.wpst-source-option-description {
|
||||
margin-top: 5px;
|
||||
color: #666;
|
||||
font-size: 13px;
|
||||
margin-top: 5px;
|
||||
color: #666;
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
/* Loading Indicator */
|
||||
.wpst-loading {
|
||||
display: inline-block;
|
||||
width: 20px;
|
||||
height: 20px;
|
||||
border: 2px solid rgba(0, 0, 0, 0.1);
|
||||
border-radius: 50%;
|
||||
border-top-color: #0073aa;
|
||||
animation: wpst-spin 1s ease-in-out infinite;
|
||||
margin-right: 10px;
|
||||
vertical-align: middle;
|
||||
display: inline-block;
|
||||
width: 20px;
|
||||
height: 20px;
|
||||
border: 2px solid rgba(0, 0, 0, 0.1);
|
||||
border-radius: 50%;
|
||||
border-top-color: #0073aa;
|
||||
animation: wpst-spin 1s ease-in-out infinite;
|
||||
margin-right: 10px;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
@keyframes wpst-spin {
|
||||
to {
|
||||
transform: rotate(360deg);
|
||||
}
|
||||
to {
|
||||
transform: rotate(360deg);
|
||||
}
|
||||
}
|
||||
|
||||
/* Message Styles */
|
||||
.wpst-modal-message {
|
||||
padding: 10px;
|
||||
margin: 10px 0;
|
||||
border-radius: 3px;
|
||||
display: none;
|
||||
padding: 10px;
|
||||
margin: 10px 0;
|
||||
border-radius: 3px;
|
||||
display: none;
|
||||
}
|
||||
|
||||
.wpst-modal-message.success {
|
||||
background-color: #ecf7ed;
|
||||
border: 1px solid #46b450;
|
||||
color: #2a6f31;
|
||||
background-color: #ecf7ed;
|
||||
border: 1px solid #46b450;
|
||||
color: #2a6f31;
|
||||
}
|
||||
|
||||
.wpst-modal-message.error {
|
||||
background-color: #fbeaea;
|
||||
border: 1px solid #dc3232;
|
||||
color: #8a1f1f;
|
||||
background-color: #fbeaea;
|
||||
border: 1px solid #dc3232;
|
||||
color: #8a1f1f;
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
/**
|
||||
* Admin styles for the plugin
|
||||
*/
|
||||
|
||||
.wpst-admin-container {
|
||||
padding: 20px;
|
||||
background: #fff;
|
||||
border: 1px solid #ccd0d4;
|
||||
box-shadow: 0 1px 1px rgba(0, 0, 0, 0.04);
|
||||
margin-top: 20px;
|
||||
}
|
||||
|
||||
.wpst-admin-header {
|
||||
margin-bottom: 20px;
|
||||
border-bottom: 1px solid #eee;
|
||||
padding-bottom: 20px;
|
||||
}
|
||||
|
||||
.wpst-admin-header h1 {
|
||||
margin-top: 0;
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
/**
|
||||
* Admin scripts for the plugin
|
||||
*/
|
||||
|
||||
(function($) {
|
||||
'use strict';
|
||||
|
||||
$(document).ready(function() {
|
||||
// Plugin admin functionality will go here
|
||||
});
|
||||
|
||||
})(jQuery);
|
||||
+5
-2
@@ -14,9 +14,12 @@
|
||||
"php": ">=7.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^7.5",
|
||||
"phpunit/phpunit": "^6.5 || ^7.5 || ^8.0 || ^9.0",
|
||||
"squizlabs/php_codesniffer": "^3.5",
|
||||
"wp-coding-standards/wpcs": "^2.3"
|
||||
"wp-coding-standards/wpcs": "^2.3",
|
||||
"dealerdirect/phpcodesniffer-composer-installer": "^0.7.0",
|
||||
"10up/wp_mock": "0.3.0",
|
||||
"antecedent/patchwork": "^2.1.21"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
|
||||
@@ -1 +1,31 @@
|
||||
<?php
|
||||
/**
|
||||
* Core functionality for the plugin
|
||||
*
|
||||
* @package WPALLSTARS\PluginStarterTemplate
|
||||
*/
|
||||
|
||||
namespace WPALLSTARS\PluginStarterTemplate;
|
||||
|
||||
/**
|
||||
* Core class
|
||||
*/
|
||||
class Core {
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*/
|
||||
public function __construct() {
|
||||
// Initialize hooks.
|
||||
}
|
||||
|
||||
/**
|
||||
* Example method to filter content
|
||||
*
|
||||
* @param string $content The content to filter.
|
||||
* @return string The filtered content.
|
||||
*/
|
||||
public function filter_content( $content ) {
|
||||
return $content;
|
||||
}
|
||||
}
|
||||
@@ -1 +1,54 @@
|
||||
<?php
|
||||
/**
|
||||
* Main plugin class
|
||||
*
|
||||
* @package WPALLSTARS\PluginStarterTemplate
|
||||
*/
|
||||
|
||||
namespace WPALLSTARS\PluginStarterTemplate;
|
||||
|
||||
/**
|
||||
* Plugin class
|
||||
*/
|
||||
class Plugin {
|
||||
|
||||
/**
|
||||
* Core instance
|
||||
*
|
||||
* @var Core
|
||||
*/
|
||||
private $core;
|
||||
|
||||
/**
|
||||
* Plugin file
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $plugin_file;
|
||||
|
||||
/**
|
||||
* Plugin version
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $version;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param string $plugin_file Main plugin file path.
|
||||
* @param string $version Plugin version.
|
||||
*/
|
||||
public function __construct($plugin_file, $version) {
|
||||
$this->plugin_file = $plugin_file;
|
||||
$this->version = $version;
|
||||
$this->core = new Core();
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize the plugin
|
||||
*/
|
||||
public function init() {
|
||||
// Initialize plugin
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
{
|
||||
"name": "wp-plugin-starter-template-for-ai-coding",
|
||||
"version": "0.1.7",
|
||||
"description": "A comprehensive starter template for WordPress plugins with best practices for AI-assisted development.",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"start": "wp-env start",
|
||||
"stop": "wp-env stop",
|
||||
"wp-env": "wp-env",
|
||||
"multisite": "wp-env start --config=.wp-env.multisite.json",
|
||||
"test:e2e": "cypress open --config-file tests/e2e/cypress.json",
|
||||
"test:e2e:headless": "cypress run --config-file tests/e2e/cypress.json",
|
||||
"build": "./build.sh",
|
||||
"lint:php": "composer run-script phpcs",
|
||||
"fix:php": "composer run-script phpcbf",
|
||||
"test:php": "composer run-script test"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding.git"
|
||||
},
|
||||
"keywords": [
|
||||
"wordpress",
|
||||
"plugin",
|
||||
"template",
|
||||
"ai",
|
||||
"coding"
|
||||
],
|
||||
"author": "WPALLSTARS",
|
||||
"license": "GPL-2.0-or-later",
|
||||
"bugs": {
|
||||
"url": "https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/issues"
|
||||
},
|
||||
"homepage": "https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding#readme",
|
||||
"devDependencies": {
|
||||
"@wordpress/env": "^5.0.0",
|
||||
"cypress": "^9.7.0"
|
||||
}
|
||||
}
|
||||
+117
-20
@@ -1,11 +1,11 @@
|
||||
=== WordPress Plugin Starter Template ===
|
||||
=== WordPress Plugin Starter Template for AI Coding ===
|
||||
Contributors: wpallstars
|
||||
Donate link: https://www.wpallstars.com/
|
||||
Tags: starter, template, boilerplate, plugin development, ai coding
|
||||
Requires at least: 5.0
|
||||
Tested up to: 6.4
|
||||
Requires PHP: 7.0
|
||||
Stable tag: 0.1.3
|
||||
Stable tag: 0.1.7
|
||||
License: GPL-2.0+
|
||||
License URI: https://www.gnu.org/licenses/gpl-2.0.html
|
||||
|
||||
@@ -22,24 +22,25 @@ This template is based on the experience gained from developing the "Fix 'Plugin
|
||||
* **Object-Oriented Architecture**: Well-structured, maintainable code using OOP principles
|
||||
* **Namespace Support**: Modern PHP namespacing for better organization and avoiding conflicts
|
||||
* **Comprehensive Documentation**: Detailed documentation for both users and developers
|
||||
* **Testing Framework**: PHPUnit setup for unit testing
|
||||
* **Testing Framework**: PHPUnit setup for unit testing and Cypress for e2e testing
|
||||
* **Internationalization Ready**: Full support for translation and localization
|
||||
* **Update Source Selection**: Choose between WordPress.org, GitHub, or Gitea for plugin updates
|
||||
* **AI Workflow Documentation**: Detailed guides for AI-assisted development
|
||||
* **Wiki Documentation**: Ready-to-use wiki structure for comprehensive documentation
|
||||
* **Multisite Compatible**: Fully tested and compatible with WordPress multisite installations
|
||||
|
||||
= How to Use This Template =
|
||||
|
||||
1. Clone or download this repository
|
||||
2. **Important**: Begin by reading the STARTER-PROMPT.md file for detailed instructions
|
||||
2. **Important**: Begin by reading the Starter Prompt file in the wiki for detailed instructions
|
||||
3. Add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context (pin them if possible)
|
||||
4. Use the prompt in STARTER-PROMPT.md to guide the AI in customizing the template for your plugin
|
||||
4. Use the prompt in the Starter Prompt file to guide the AI in customizing the template for your plugin
|
||||
5. Rename files and update namespaces to match your plugin
|
||||
6. Customize the functionality for your specific needs
|
||||
7. Update documentation to reflect your plugin's features
|
||||
8. Build and test your plugin
|
||||
|
||||
For detailed instructions, see the [STARTER-PROMPT.md](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/blob/main/STARTER-PROMPT.md) file.
|
||||
For detailed instructions, see the [Starter Prompt](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/wiki/Starter-Prompt) file in the wiki.
|
||||
|
||||
= AI-Assisted Development =
|
||||
|
||||
@@ -47,10 +48,74 @@ This template includes comprehensive documentation for AI-assisted development:
|
||||
|
||||
* **.ai-assistant.md**: Guide for AI assistants to understand the project structure
|
||||
* **.ai-workflows/**: Detailed workflow documentation for common development tasks
|
||||
* **STARTER-PROMPT.md**: Comprehensive prompt for AI tools to help customize the template
|
||||
* **Starter Prompt**: Comprehensive prompt for AI tools to help customize the template (available in the wiki)
|
||||
|
||||
**Important**: For the best AI assistance, add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message.
|
||||
|
||||
= Development Environment =
|
||||
|
||||
This template includes configuration for WordPress Environment (wp-env) to make local development easier:
|
||||
|
||||
1. Install Node.js dependencies:
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
2. Start the WordPress environment:
|
||||
```bash
|
||||
npm run start
|
||||
```
|
||||
|
||||
3. For multisite testing:
|
||||
```bash
|
||||
npm run multisite
|
||||
```
|
||||
|
||||
4. Access your local WordPress site at http://localhost:8888 (admin credentials: admin/password)
|
||||
|
||||
= Testing =
|
||||
|
||||
The template includes both PHP unit tests and end-to-end tests:
|
||||
|
||||
**PHP Unit Tests**
|
||||
|
||||
1. Install Composer dependencies:
|
||||
```bash
|
||||
composer install
|
||||
```
|
||||
|
||||
2. Run PHP unit tests:
|
||||
```bash
|
||||
npm run test:php
|
||||
```
|
||||
|
||||
3. Check PHP coding standards:
|
||||
```bash
|
||||
npm run lint:php
|
||||
```
|
||||
|
||||
4. Fix PHP coding standards issues:
|
||||
```bash
|
||||
npm run fix:php
|
||||
```
|
||||
|
||||
**End-to-End Tests**
|
||||
|
||||
1. Start the WordPress environment:
|
||||
```bash
|
||||
npm run start
|
||||
```
|
||||
|
||||
2. Run Cypress tests in interactive mode:
|
||||
```bash
|
||||
npm run test:e2e
|
||||
```
|
||||
|
||||
3. Run Cypress tests in headless mode:
|
||||
```bash
|
||||
npm run test:e2e:headless
|
||||
```
|
||||
|
||||
= Support & Feedback =
|
||||
|
||||
If you need help with this template, there are several ways to get support:
|
||||
@@ -71,21 +136,21 @@ Contributions are welcome! Please feel free to submit a Pull Request.
|
||||
== Installation ==
|
||||
|
||||
1. Clone or download this repository
|
||||
2. Read the STARTER-PROMPT.md file for detailed instructions
|
||||
2. Read the Starter Prompt file in the wiki for detailed instructions
|
||||
3. Add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context
|
||||
4. Use the prompt in STARTER-PROMPT.md to guide the AI in customizing the template
|
||||
4. Use the prompt in the Starter Prompt file to guide the AI in customizing the template
|
||||
5. Rename files and update namespaces to match your plugin
|
||||
6. Customize the functionality for your specific needs
|
||||
7. Update documentation to reflect your plugin's features
|
||||
8. Build and test your plugin
|
||||
|
||||
For detailed instructions, see the [STARTER-PROMPT.md](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/blob/main/STARTER-PROMPT.md) file.
|
||||
For detailed instructions, see the [Starter Prompt](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/wiki/Starter-Prompt) file in the wiki.
|
||||
|
||||
== Frequently Asked Questions ==
|
||||
|
||||
= How do I customize this template for my plugin? =
|
||||
|
||||
See the [STARTER-PROMPT.md](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/blob/main/STARTER-PROMPT.md) file for detailed instructions on customizing this template for your specific plugin needs. Make sure to add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context for the best results.
|
||||
See the [Starter Prompt](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/wiki/Starter-Prompt) file in the wiki for detailed instructions on customizing this template for your specific plugin needs. Make sure to add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context for the best results.
|
||||
|
||||
= What files do I need to update with my plugin information? =
|
||||
|
||||
@@ -95,13 +160,14 @@ The main files you need to update include:
|
||||
3. readme.txt
|
||||
4. CHANGELOG.md
|
||||
5. composer.json
|
||||
6. languages/pot file
|
||||
7. .github/workflows/
|
||||
8. .wiki/
|
||||
9. .ai-assistant.md
|
||||
10. includes/plugin.php
|
||||
11. includes/core.php
|
||||
12. admin/lib/admin.php
|
||||
6. package.json
|
||||
7. languages/pot file
|
||||
8. .github/workflows/
|
||||
9. .wiki/
|
||||
10. .ai-assistant.md
|
||||
11. includes/plugin.php
|
||||
12. includes/core.php
|
||||
13. admin/lib/admin.php
|
||||
|
||||
= How do I build and test my plugin? =
|
||||
|
||||
@@ -125,15 +191,37 @@ You'll need to update all namespace references from WPALLSTARS\PluginStarterTemp
|
||||
|
||||
You'll need to update all text domain references from 'wp-plugin-starter-template' to your own text domain throughout the codebase.
|
||||
|
||||
= Is this template compatible with WordPress multisite? =
|
||||
|
||||
Yes, this template is fully compatible with WordPress multisite installations. You can test multisite compatibility by running:
|
||||
|
||||
```bash
|
||||
npm run multisite
|
||||
```
|
||||
|
||||
== Screenshots ==
|
||||
|
||||
1. This is a placeholder for your plugin's screenshots. Replace with actual screenshots of your plugin in action.
|
||||
|
||||
== Changelog ==
|
||||
|
||||
= 0.1.7 =
|
||||
* Fixed: GitHub Actions tests workflow with proper file paths and dependencies
|
||||
* Improved: Workflow names for better clarity in GitHub Actions UI
|
||||
|
||||
= 0.1.6 =
|
||||
* Fixed: GitHub Actions workflows permissions for releases and wiki sync
|
||||
|
||||
= 0.1.5 =
|
||||
* Fixed: Release workflow to use correct plugin directory name
|
||||
* Added: Testing setup with wp-env and Cypress
|
||||
* Added: Multisite compatibility
|
||||
* Added: npm scripts for development and testing
|
||||
|
||||
= 0.1.3 =
|
||||
* Added: Improved AI IDE context recommendations in documentation
|
||||
* Enhanced: STARTER-PROMPT.md with guidance on pinning .ai-assistant.md and .ai-workflows/
|
||||
* Enhanced: Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/
|
||||
* Moved: Starter Prompt to the wiki for better organization
|
||||
* Updated: README.md and readme.txt with AI IDE context recommendations
|
||||
* Improved: Documentation for AI-assisted development
|
||||
|
||||
@@ -157,8 +245,17 @@ You'll need to update all text domain references from 'wp-plugin-starter-templat
|
||||
|
||||
== Upgrade Notice ==
|
||||
|
||||
= 0.1.7 =
|
||||
Fixed GitHub Actions tests workflow and improved workflow names for better clarity.
|
||||
|
||||
= 0.1.6 =
|
||||
Fixed GitHub Actions workflows permissions for releases and wiki sync.
|
||||
|
||||
= 0.1.5 =
|
||||
Fixed release workflow and added testing setup with wp-env and Cypress, multisite compatibility, and npm scripts for development and testing.
|
||||
|
||||
= 0.1.3 =
|
||||
Added improved AI IDE context recommendations and enhanced STARTER-PROMPT.md with guidance on pinning .ai-assistant.md and .ai-workflows/ files.
|
||||
Added improved AI IDE context recommendations and moved Starter Prompt to the wiki with guidance on pinning .ai-assistant.md and .ai-workflows/ files.
|
||||
|
||||
= 0.1.1 =
|
||||
Updated LICENSE file with correct GPL-2.0 text.
|
||||
|
||||
@@ -8,6 +8,8 @@
|
||||
// First, we need to load the composer autoloader so we can use WP Mock.
|
||||
require_once dirname(__DIR__) . '/vendor/autoload.php';
|
||||
|
||||
// No need to import WP_Mock classes here
|
||||
|
||||
// Now call the bootstrap method of WP Mock.
|
||||
WP_Mock::bootstrap();
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"baseUrl": "http://localhost:8889",
|
||||
"integrationFolder": "tests/e2e/cypress/integration",
|
||||
"pluginsFile": "tests/e2e/cypress/plugins/index.js",
|
||||
"supportFile": "tests/e2e/cypress/support/index.js",
|
||||
"videosFolder": "tests/e2e/cypress/videos",
|
||||
"screenshotsFolder": "tests/e2e/cypress/screenshots",
|
||||
"fixturesFolder": "tests/e2e/cypress/fixtures"
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
/**
|
||||
* Basic e2e test for the plugin.
|
||||
*/
|
||||
describe('Plugin Basic Tests', () => {
|
||||
before(() => {
|
||||
cy.login();
|
||||
});
|
||||
|
||||
it('Should activate the plugin', () => {
|
||||
cy.visit('/wp-admin/plugins.php');
|
||||
cy.contains('WP Plugin Starter Template').should('exist');
|
||||
|
||||
// Check if plugin is not active, then activate it
|
||||
cy.get('tr[data-slug="wp-plugin-starter-template-for-ai-coding"]')
|
||||
.then(($tr) => {
|
||||
if ($tr.hasClass('inactive')) {
|
||||
cy.wrap($tr).find('.activate a').click();
|
||||
cy.contains('Plugin activated.').should('exist');
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
it('Should have the plugin settings page', () => {
|
||||
cy.visit('/wp-admin/options-general.php?page=wp-plugin-starter-template');
|
||||
cy.contains('WP Plugin Starter Template Settings').should('exist');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,10 @@
|
||||
/**
|
||||
* Cypress plugins file.
|
||||
*
|
||||
* @param {Object} on - Cypress events
|
||||
* @param {Object} config - Cypress config
|
||||
* @return {Object} - Modified config
|
||||
*/
|
||||
module.exports = (on, config) => {
|
||||
return config;
|
||||
};
|
||||
@@ -0,0 +1,12 @@
|
||||
/**
|
||||
* Custom Cypress commands.
|
||||
*/
|
||||
|
||||
// Login command
|
||||
Cypress.Commands.add('login', (username = 'admin', password = 'password') => {
|
||||
cy.visit('/wp-login.php');
|
||||
cy.get('#user_login').type(username);
|
||||
cy.get('#user_pass').type(password);
|
||||
cy.get('#wp-submit').click();
|
||||
cy.get('body.wp-admin').should('exist');
|
||||
});
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
* Import commands.js
|
||||
*/
|
||||
import './commands';
|
||||
+14
-14
@@ -11,7 +11,7 @@ use WPALLSTARS\PluginStarterTemplate\Core;
|
||||
/**
|
||||
* Admin test case.
|
||||
*/
|
||||
class AdminTest extends WP_Mock\Tools\TestCase {
|
||||
class AdminTest extends \WP_Mock\Tools\TestCase {
|
||||
|
||||
/**
|
||||
* Test instance
|
||||
@@ -30,21 +30,21 @@ class AdminTest extends WP_Mock\Tools\TestCase {
|
||||
/**
|
||||
* Set up test environment
|
||||
*/
|
||||
public function setUp(): void {
|
||||
public function setUp() {
|
||||
parent::setUp();
|
||||
|
||||
|
||||
// Set up mocks
|
||||
WP_Mock::setUp();
|
||||
|
||||
|
||||
// Mock Core class
|
||||
$this->core = $this->createMock(Core::class);
|
||||
|
||||
|
||||
// Set up WordPress function mocks
|
||||
WP_Mock::userFunction('add_action', [
|
||||
'times' => 1,
|
||||
'args' => ['admin_enqueue_scripts', \WP_Mock\Functions::type('array')],
|
||||
]);
|
||||
|
||||
|
||||
// Create instance of Admin class
|
||||
$this->admin = new Admin($this->core);
|
||||
}
|
||||
@@ -52,7 +52,7 @@ class AdminTest extends WP_Mock\Tools\TestCase {
|
||||
/**
|
||||
* Tear down test environment
|
||||
*/
|
||||
public function tearDown(): void {
|
||||
public function tearDown() {
|
||||
WP_Mock::tearDown();
|
||||
parent::tearDown();
|
||||
}
|
||||
@@ -74,38 +74,38 @@ class AdminTest extends WP_Mock\Tools\TestCase {
|
||||
'times' => 1,
|
||||
'args' => ['wpst-admin-styles', \WP_Mock\Functions::type('string'), [], \WP_Mock\Functions::type('string')],
|
||||
]);
|
||||
|
||||
|
||||
WP_Mock::userFunction('wp_enqueue_script', [
|
||||
'times' => 1,
|
||||
'args' => ['wpst-admin-scripts', \WP_Mock\Functions::type('string'), ['jquery'], \WP_Mock\Functions::type('string'), true],
|
||||
]);
|
||||
|
||||
|
||||
WP_Mock::userFunction('wp_localize_script', [
|
||||
'times' => 1,
|
||||
'args' => ['wpst-admin-scripts', 'wpstData', \WP_Mock\Functions::type('array')],
|
||||
]);
|
||||
|
||||
|
||||
WP_Mock::userFunction('esc_html__', [
|
||||
'times' => 2,
|
||||
'args' => [\WP_Mock\Functions::type('string'), 'wp-plugin-starter-template'],
|
||||
'return' => 'Translated string',
|
||||
]);
|
||||
|
||||
|
||||
WP_Mock::userFunction('admin_url', [
|
||||
'times' => 1,
|
||||
'args' => ['admin-ajax.php'],
|
||||
'return' => 'http://example.org/wp-admin/admin-ajax.php',
|
||||
]);
|
||||
|
||||
|
||||
WP_Mock::userFunction('wp_create_nonce', [
|
||||
'times' => 1,
|
||||
'args' => ['wpst-admin-nonce'],
|
||||
'return' => '1234567890',
|
||||
]);
|
||||
|
||||
|
||||
// Call the method
|
||||
$this->admin->enqueue_admin_assets('plugins.php');
|
||||
|
||||
|
||||
// If we get here, the test passed
|
||||
$this->assertTrue(true);
|
||||
}
|
||||
|
||||
+6
-6
@@ -10,7 +10,7 @@ use WPALLSTARS\PluginStarterTemplate\Core;
|
||||
/**
|
||||
* Core test case.
|
||||
*/
|
||||
class CoreTest extends WP_Mock\Tools\TestCase {
|
||||
class CoreTest extends \WP_Mock\Tools\TestCase {
|
||||
|
||||
/**
|
||||
* Test instance
|
||||
@@ -22,12 +22,12 @@ class CoreTest extends WP_Mock\Tools\TestCase {
|
||||
/**
|
||||
* Set up test environment
|
||||
*/
|
||||
public function setUp(): void {
|
||||
public function setUp() {
|
||||
parent::setUp();
|
||||
|
||||
|
||||
// Set up mocks
|
||||
WP_Mock::setUp();
|
||||
|
||||
|
||||
// Create instance of Core class
|
||||
$this->core = new Core();
|
||||
}
|
||||
@@ -35,7 +35,7 @@ class CoreTest extends WP_Mock\Tools\TestCase {
|
||||
/**
|
||||
* Tear down test environment
|
||||
*/
|
||||
public function tearDown(): void {
|
||||
public function tearDown() {
|
||||
WP_Mock::tearDown();
|
||||
parent::tearDown();
|
||||
}
|
||||
@@ -53,7 +53,7 @@ class CoreTest extends WP_Mock\Tools\TestCase {
|
||||
*/
|
||||
public function test_filter_content() {
|
||||
$content = 'Test content';
|
||||
|
||||
|
||||
// Test that filter_content returns the content
|
||||
$this->assertEquals($content, $this->core->filter_content($content));
|
||||
}
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# Changelog
|
||||
|
||||
This page documents all notable changes to the WordPress Plugin Starter Template.
|
||||
|
||||
## Version 0.1.0 (2025-04-17)
|
||||
- Initial release with basic template structure
|
||||
- Added core plugin architecture with OOP approach
|
||||
- Added admin interface components and styling
|
||||
- Added update mechanism with multiple source options
|
||||
- Added documentation templates for users and developers
|
||||
- Added AI workflow documentation for AI-assisted development
|
||||
- Added GitHub Actions workflows for automated tasks
|
||||
- Added wiki documentation templates
|
||||
@@ -0,0 +1,118 @@
|
||||
# Frequently Asked Questions
|
||||
|
||||
This page answers common questions about the WordPress Plugin Starter Template.
|
||||
|
||||
## General Questions
|
||||
|
||||
### What is the WordPress Plugin Starter Template?
|
||||
|
||||
The WordPress Plugin Starter Template is a comprehensive starting point for developing WordPress plugins. It provides a well-structured codebase, documentation templates, and best practices to help you create high-quality WordPress plugins efficiently.
|
||||
|
||||
### Who is this template for?
|
||||
|
||||
This template is designed for:
|
||||
- WordPress plugin developers looking for a solid foundation
|
||||
- Developers who want to leverage AI assistance in their development workflow
|
||||
- Anyone who wants to create a WordPress plugin following best practices
|
||||
|
||||
### Is this template suitable for all types of plugins?
|
||||
|
||||
Yes, this template provides a solid foundation for most WordPress plugins. It's designed to be flexible and can be adapted for various types of plugins, from simple utilities to complex applications.
|
||||
|
||||
## Usage Questions
|
||||
|
||||
### How do I use this template?
|
||||
|
||||
This template is meant to be a starting point for your own plugin development. You should:
|
||||
|
||||
1. Copy the template files to your new plugin directory
|
||||
2. Rename files and update namespaces to match your plugin name
|
||||
3. Update plugin headers in the main PHP file
|
||||
4. Customize the functionality to meet your specific needs
|
||||
5. Update documentation to reflect your plugin's features
|
||||
|
||||
For detailed instructions, see the [Usage Instructions](Usage-Instructions) page.
|
||||
|
||||
### Do I need to keep the original credits?
|
||||
|
||||
While not strictly required, we appreciate if you keep a reference to the original template in your plugin's documentation. This helps others discover the template and contributes to the open-source community.
|
||||
|
||||
### Can I use this template for commercial plugins?
|
||||
|
||||
Yes, you can use this template for both free and commercial plugins. The template is licensed under GPL-2.0+, which allows for commercial use.
|
||||
|
||||
## Technical Questions
|
||||
|
||||
### What PHP version is required?
|
||||
|
||||
The template requires PHP 7.0 or higher, which is the minimum recommended version for WordPress plugins today.
|
||||
|
||||
### Does this template support Gutenberg blocks?
|
||||
|
||||
The template doesn't include Gutenberg blocks by default, but it provides a structure that makes it easy to add them. You can extend the template to include block registration and block-specific assets.
|
||||
|
||||
### How do I add custom post types or taxonomies?
|
||||
|
||||
To add custom post types or taxonomies:
|
||||
|
||||
1. Create a new class in `includes/` for your post type or taxonomy
|
||||
2. Register the post type or taxonomy in the class constructor
|
||||
3. Initialize the class in `includes/plugin.php`
|
||||
|
||||
### How do I handle plugin updates?
|
||||
|
||||
The template includes an update mechanism that supports multiple sources:
|
||||
|
||||
- WordPress.org
|
||||
- GitHub
|
||||
- Gitea
|
||||
|
||||
To configure the update mechanism:
|
||||
|
||||
1. Update the plugin headers in the main PHP file
|
||||
2. Customize the `updater.php` file if needed
|
||||
3. Ensure your repository follows the required structure for updates
|
||||
|
||||
## AI-Assisted Development Questions
|
||||
|
||||
### How does this template support AI-assisted development?
|
||||
|
||||
The template includes:
|
||||
|
||||
1. Detailed documentation in the `.ai-assistant.md` file
|
||||
2. Workflow guidelines in the `.ai-workflows/` directory
|
||||
3. Clear code structure and comments that help AI understand the codebase
|
||||
4. Best practices for AI-friendly code organization
|
||||
|
||||
### What AI tools work best with this template?
|
||||
|
||||
This template is designed to work well with various AI coding assistants, including:
|
||||
|
||||
- GitHub Copilot
|
||||
- Claude
|
||||
- ChatGPT
|
||||
- Other AI coding assistants
|
||||
|
||||
### How do I use the AI workflow documentation?
|
||||
|
||||
The AI workflow documentation in the `.ai-workflows/` directory provides guidelines for AI assistants working with this template. These files help ensure consistent, high-quality code and documentation when using AI tools for development.
|
||||
|
||||
## Contributing Questions
|
||||
|
||||
### How can I contribute to this template?
|
||||
|
||||
Contributions are welcome! Please feel free to:
|
||||
|
||||
1. Report bugs or issues
|
||||
2. Suggest new features or improvements
|
||||
3. Submit pull requests with bug fixes or enhancements
|
||||
|
||||
For more information, see the [Contributing](Contributing) page.
|
||||
|
||||
### Where can I report issues?
|
||||
|
||||
You can report issues on the [GitHub repository](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/issues).
|
||||
|
||||
### Is there a roadmap for future development?
|
||||
|
||||
Yes, we maintain a roadmap of planned features and improvements. You can find it in the [GitHub repository](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/projects).
|
||||
@@ -0,0 +1,41 @@
|
||||
# WordPress Plugin Starter Template
|
||||
|
||||
Welcome to the documentation wiki for the WordPress Plugin Starter Template.
|
||||
|
||||
This template provides a solid foundation for developing WordPress plugins with best practices for AI-assisted development.
|
||||
|
||||
## Quick Links
|
||||
|
||||
- [Starter Prompt](Starter-Prompt)
|
||||
- [Installation Guide](Installation-Guide)
|
||||
- [Usage Instructions](Usage-Instructions)
|
||||
- [Frequently Asked Questions](Frequently-Asked-Questions)
|
||||
- [Contributing](Contributing)
|
||||
- [Changelog](Changelog)
|
||||
|
||||
## About This Template
|
||||
|
||||
The WordPress Plugin Starter Template is designed to help developers quickly create new WordPress plugins with a solid foundation of best practices. It incorporates modern coding standards, comprehensive documentation, and AI-assisted development workflows.
|
||||
|
||||
This template is based on the experience gained from developing the "Fix 'Plugin file does not exist' Notices" plugin and other successful WordPress plugins.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Object-Oriented Architecture**: Well-structured, maintainable code using OOP principles
|
||||
- **Namespace Support**: Modern PHP namespacing for better organization and avoiding conflicts
|
||||
- **Comprehensive Documentation**: Detailed documentation for both users and developers
|
||||
- **Testing Framework**: PHPUnit setup for unit testing
|
||||
- **Internationalization Ready**: Full support for translation and localization
|
||||
- **Update Source Selection**: Choose between WordPress.org, GitHub, or Gitea for plugin updates
|
||||
- **AI Workflow Documentation**: Detailed guides for AI-assisted development
|
||||
- **Wiki Documentation**: Ready-to-use wiki structure for comprehensive documentation
|
||||
|
||||
## Getting Started
|
||||
|
||||
To get started with this template, check out the [Starter Prompt](Starter-Prompt) for a comprehensive guide on customizing the template for your specific plugin needs.
|
||||
|
||||
**Important**: For the best AI assistance, add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message.
|
||||
|
||||
## Support
|
||||
|
||||
If you encounter any issues or have questions about the template, please check the [Frequently Asked Questions](Frequently-Asked-Questions) section. If you still need help, you can [open an issue](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/issues) on GitHub.
|
||||
@@ -0,0 +1,81 @@
|
||||
# Installation Guide
|
||||
|
||||
This guide provides instructions for installing and setting up the WordPress Plugin Starter Template.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before installing the plugin, ensure you have:
|
||||
|
||||
- WordPress 5.0 or higher
|
||||
- PHP 7.0 or higher
|
||||
- A WordPress site with administrator access
|
||||
|
||||
## Installation Methods
|
||||
|
||||
### Method 1: From WordPress.org (For Released Plugins)
|
||||
|
||||
1. Log in to your WordPress admin dashboard.
|
||||
2. Navigate to **Plugins > Add New**.
|
||||
3. Search for "WordPress Plugin Starter Template".
|
||||
4. Click **Install Now** next to the plugin.
|
||||
5. After installation, click **Activate**.
|
||||
|
||||
### Method 2: Manual Installation
|
||||
|
||||
1. Download the latest release from the [GitHub repository](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/releases).
|
||||
2. Log in to your WordPress admin dashboard.
|
||||
3. Navigate to **Plugins > Add New**.
|
||||
4. Click the **Upload Plugin** button at the top of the page.
|
||||
5. Click **Choose File** and select the downloaded ZIP file.
|
||||
6. Click **Install Now**.
|
||||
7. After installation, click **Activate**.
|
||||
|
||||
### Method 3: Using as a Template for Your Plugin
|
||||
|
||||
1. Clone or download the repository:
|
||||
```bash
|
||||
git clone https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding.git your-plugin-name
|
||||
```
|
||||
|
||||
2. Navigate to your plugin directory:
|
||||
```bash
|
||||
cd your-plugin-name
|
||||
```
|
||||
|
||||
3. Rename files and update namespaces:
|
||||
- Rename `wp-plugin-starter-template.php` to your plugin name (e.g., `your-plugin-name.php`)
|
||||
- Update the namespace from `WPALLSTARS\PluginStarterTemplate` to your own
|
||||
- Update text domain from `wp-plugin-starter-template` to your own
|
||||
|
||||
4. Update plugin headers in the main PHP file.
|
||||
|
||||
5. Install dependencies:
|
||||
```bash
|
||||
composer install
|
||||
```
|
||||
|
||||
6. Upload the plugin to your WordPress site or use the local development script:
|
||||
```bash
|
||||
./scripts/deploy-local.sh
|
||||
```
|
||||
|
||||
## Post-Installation
|
||||
|
||||
After installing and activating the plugin, you should:
|
||||
|
||||
1. Review the plugin settings (if applicable).
|
||||
2. Customize the plugin for your specific needs.
|
||||
3. Update documentation to reflect your plugin's features.
|
||||
|
||||
## Troubleshooting Installation Issues
|
||||
|
||||
If you encounter any issues during installation, please check the following:
|
||||
|
||||
1. **Plugin Conflicts**: Deactivate other plugins to check for conflicts.
|
||||
2. **Server Requirements**: Ensure your server meets the minimum requirements.
|
||||
3. **File Permissions**: Check that your WordPress installation has the correct file permissions.
|
||||
4. **Memory Limit**: Increase PHP memory limit if you encounter memory-related errors.
|
||||
|
||||
## Next Steps
|
||||
|
||||
After installation, refer to the [Usage Instructions](Usage-Instructions) to learn how to use and customize the plugin.
|
||||
File renamed without changes.
@@ -0,0 +1,121 @@
|
||||
# Usage Instructions
|
||||
|
||||
This guide provides instructions for using and customizing the WordPress Plugin Starter Template for your own plugin development.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
The WordPress Plugin Starter Template is designed to be a starting point for your WordPress plugin development. It provides a well-structured codebase that you can customize to create your own plugin.
|
||||
|
||||
### Template Structure
|
||||
|
||||
The template follows a modular structure:
|
||||
|
||||
- `wp-plugin-starter-template.php`: Main plugin file with plugin headers
|
||||
- `includes/`: Core plugin functionality
|
||||
- `plugin.php`: Main plugin class that initializes everything
|
||||
- `core.php`: Core functionality class
|
||||
- `updater.php`: Update mechanism for multiple sources
|
||||
- `admin/`: Admin-specific functionality
|
||||
- `lib/`: Admin classes
|
||||
- `css/`: Admin stylesheets
|
||||
- `js/`: Admin JavaScript files
|
||||
- `languages/`: Translation files
|
||||
- `.github/workflows/`: GitHub Actions workflows
|
||||
- `.ai-workflows/`: Documentation for AI assistants
|
||||
- `.wiki/`: Wiki documentation templates
|
||||
|
||||
### Customizing for Your Plugin
|
||||
|
||||
1. **Rename Files and Update Namespaces**:
|
||||
- Rename `wp-plugin-starter-template.php` to your plugin name
|
||||
- Update the namespace from `WPALLSTARS\PluginStarterTemplate` to your own
|
||||
- Update text domain from `wp-plugin-starter-template` to your own
|
||||
|
||||
2. **Update Plugin Headers**:
|
||||
- Edit the plugin headers in the main PHP file
|
||||
- Update GitHub/Gitea repository URLs
|
||||
|
||||
3. **Customize Functionality**:
|
||||
- Modify the core functionality in `includes/core.php`
|
||||
- Add your own classes as needed
|
||||
- Customize admin interfaces in the `admin/` directory
|
||||
|
||||
4. **Update Documentation**:
|
||||
- Update README.md and readme.txt with your plugin information
|
||||
- Customize wiki documentation in the `.wiki/` directory
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
### Adding Admin Pages
|
||||
|
||||
The template includes a structure for adding admin pages to the WordPress dashboard. To add an admin page:
|
||||
|
||||
1. Uncomment the `add_admin_menu` method in `admin/lib/admin.php`
|
||||
2. Customize the menu parameters to match your plugin
|
||||
3. Create the corresponding render method for your admin page
|
||||
4. Create template files in an `admin/templates/` directory
|
||||
|
||||
### Adding Settings
|
||||
|
||||
To add settings to your plugin:
|
||||
|
||||
1. Create a settings class in `includes/settings.php`
|
||||
2. Register settings using the WordPress Settings API
|
||||
3. Create form fields for your settings
|
||||
4. Handle settings validation and sanitization
|
||||
|
||||
### Adding Custom Post Types or Taxonomies
|
||||
|
||||
To add custom post types or taxonomies:
|
||||
|
||||
1. Create a new class in `includes/` for your post type or taxonomy
|
||||
2. Register the post type or taxonomy in the class constructor
|
||||
3. Initialize the class in `includes/plugin.php`
|
||||
|
||||
### Internationalization
|
||||
|
||||
The template is ready for internationalization. To make your plugin translatable:
|
||||
|
||||
1. Use translation functions for all user-facing strings:
|
||||
- `__()` for simple strings
|
||||
- `_e()` for echoed strings
|
||||
- `esc_html__()` for escaped strings
|
||||
2. Update the text domain in all translation functions
|
||||
3. Generate a POT file for translations
|
||||
|
||||
### Update Mechanism
|
||||
|
||||
The template includes an update mechanism that supports multiple sources:
|
||||
|
||||
- WordPress.org
|
||||
- GitHub
|
||||
- Gitea
|
||||
|
||||
To configure the update mechanism:
|
||||
|
||||
1. Update the plugin headers in the main PHP file
|
||||
2. Customize the `updater.php` file if needed
|
||||
3. Ensure your repository follows the required structure for updates
|
||||
|
||||
## Building and Releasing
|
||||
|
||||
The template includes scripts for building and releasing your plugin:
|
||||
|
||||
1. **Building the Plugin**:
|
||||
```bash
|
||||
./build.sh <version>
|
||||
```
|
||||
|
||||
2. **Deploying to a Local WordPress Installation**:
|
||||
```bash
|
||||
./scripts/deploy-local.sh
|
||||
```
|
||||
|
||||
3. **Creating a Release**:
|
||||
- Tag a new version in Git
|
||||
- Push the tag to GitHub
|
||||
- The GitHub Actions workflow will create a release
|
||||
|
||||
## Next Steps
|
||||
|
||||
After customizing the template for your needs, refer to the [Architecture Overview](Architecture-Overview) to understand the plugin's structure in more detail.
|
||||
@@ -0,0 +1,20 @@
|
||||
## User Documentation
|
||||
* [Home](Home)
|
||||
* [Installation Guide](Installation-Guide)
|
||||
* [Usage Instructions](Usage-Instructions)
|
||||
* [Frequently Asked Questions](Frequently-Asked-Questions)
|
||||
* [Troubleshooting](Troubleshooting)
|
||||
|
||||
## Developer Documentation
|
||||
* [Architecture Overview](Architecture-Overview)
|
||||
* [Customization Guide](Customization-Guide)
|
||||
* [Extending the Plugin](Extending-the-Plugin)
|
||||
* [Coding Standards](Coding-Standards)
|
||||
* [Release Process](Release-Process)
|
||||
|
||||
## AI Documentation
|
||||
* [AI Workflow Documentation](AI-Workflow-Documentation)
|
||||
|
||||
## Additional Resources
|
||||
* [Changelog](Changelog)
|
||||
* [Contributing](Contributing)
|
||||
@@ -3,7 +3,7 @@
|
||||
* Plugin Name: WordPress Plugin Starter Template
|
||||
* Plugin URI: https://www.wpallstars.com
|
||||
* Description: A comprehensive starter template for WordPress plugins with best practices for AI-assisted development.
|
||||
* Version: 0.1.3
|
||||
* Version: 0.1.7
|
||||
* Author: Your Name & The WPALLSTARS Team
|
||||
* Author URI: https://www.wpallstars.com
|
||||
* License: GPL-2.0+
|
||||
@@ -32,7 +32,7 @@ if (!defined('WPINC')) {
|
||||
}
|
||||
|
||||
// Load the main plugin class
|
||||
require_once plugin_dir_path(__FILE__) . 'includes/plugin.php';
|
||||
require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin.php';
|
||||
|
||||
// Initialize the plugin
|
||||
new WPALLSTARS\PluginStarterTemplate\Plugin(__FILE__, '0.1.3');
|
||||
new WPALLSTARS\PluginStarterTemplate\Plugin(__FILE__, '0.1.7');
|
||||
Reference in new issue
Block a user