Introduction
Submitting your WordPress plugin to the official repository can expose your work to a wider audience and contribute to the open-source WordPress community. In this tutorial, I will share my experience of submitting my first WordPress plugin to the repository and guide you through the process.
My Journey
As a long-time user of WordPress, I noticed some missing plugins in the vast collection available in the repository. Inspired by my earlier post on using rel=canonical for content syndication, I decided to develop a plugin to address this need. However, as a non-developer, I faced several challenges along the way.
The Submission Process
Submitting a plugin to the repository may seem simple at first, but it can be daunting for those with no prior experience. To simplify the process, I followed the official WordPress help file and referred to various resources. Some steps were straightforward, while others required a deeper understanding of the SVN client and plugin updates.
Simplifying the Process
Based on the challenges I encountered, I have compiled a simplified step-by-step guide for anyone looking to submit their own plugin. If you encounter any issues, feel free to ask for help in the comments section. This guide is a learning process for me as well, and I will continually update it with new information.
Getting Started: Setting Up Your Plugin File
Before submitting your plugin, you need to create a Zip archive of your plugin file. Make sure to include all necessary details, such as a readme file and images, in the same folder. The readme file is crucial, as it contains essential information about your plugin, including your name and website. You can use the standard readme.txt file from WordPress or a readme generator plugin to create your own.
Preparing Your Plugin File Structure
To ensure your plugin file is properly organized, create a folder named “assets” and add screenshots of your plugin there. Update your readme.txt file to reference these screenshots. Here is an example structure of the directory:
PluginName
|-- trunk
| |-- plugin-files.php
| `-- readme.txt
`-- assets
|-- screenshot-1.png
`-- screenshot-2.png
Validating Your Plugin File
After creating the text file, validate it using the official validator tool provided by WordPress. This step ensures that your plugin file is error-free and prepared for submission.
Creating the Zip Archive
Create a single Zip archive of your plugin file, including the folder structure mentioned earlier. Upload this archive to your server or Dropbox folder. You will need to provide a link to this archive during the submission process.
Submitting Your Plugin
Before adding your plugin, create a free WordPress.org profile if you haven’t already. Once you have a profile, navigate to the WordPress plugin submission page and follow the instructions. After submitting your plugin, you will receive an email from the WordPress team regarding the status of your submission.
Approval and SVN Submission
Upon approval, you will gain access to your SVN repository. Use an SVN client, such as the Versions app for Mac, to submit your plugin. Enter your unique SVN link and log in using your WordPress username and password. Once connected, you can checkout a local folder of your repository, make changes, and commit them when ready.
Finalizing Your Plugin Submission
Make sure to update the readme.txt, changelog, stable tag, and version tag to reflect any changes. Copy your images to the assets folder and your plugin files to the trunk folder in your local repository. After adding and committing the changes, your plugin will be live for users.
Verifying Your Plugin Submission
You will receive an email notification when a file is successfully added with your message. If this is your first release, check your WordPress profile to ensure that your plugin is listed correctly.
