2.6 KiB
2.6 KiB
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)
- Log in to your WordPress admin dashboard.
- Navigate to Plugins > Add New.
- Search for "WordPress Plugin Starter Template".
- Click Install Now next to the plugin.
- After installation, click Activate.
Method 2: Manual Installation
- Download the latest release from the GitHub repository.
- Log in to your WordPress admin dashboard.
- Navigate to Plugins > Add New.
- Click the Upload Plugin button at the top of the page.
- Click Choose File and select the downloaded ZIP file.
- Click Install Now.
- After installation, click Activate.
Method 3: Using as a Template for Your Plugin
-
Clone or download the repository:
git clone https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding.git your-plugin-name -
Navigate to your plugin directory:
cd your-plugin-name -
Rename files and update namespaces:
- Rename
wp-plugin-starter-template.phpto your plugin name (e.g.,your-plugin-name.php) - Update the namespace from
WPALLSTARS\PluginStarterTemplateto your own - Update text domain from
wp-plugin-starter-templateto your own
- Rename
-
Update plugin headers in the main PHP file.
-
Install dependencies:
composer install -
Upload the plugin to your WordPress site or use the local development script:
./scripts/deploy-local.sh
Post-Installation
After installing and activating the plugin, you should:
- Review the plugin settings (if applicable).
- Customize the plugin for your specific needs.
- Update documentation to reflect your plugin's features.
Troubleshooting Installation Issues
If you encounter any issues during installation, please check the following:
- Plugin Conflicts: Deactivate other plugins to check for conflicts.
- Server Requirements: Ensure your server meets the minimum requirements.
- File Permissions: Check that your WordPress installation has the correct file permissions.
- Memory Limit: Increase PHP memory limit if you encounter memory-related errors.
Next Steps
After installation, refer to the Usage Instructions to learn how to use and customize the plugin.