Publishing your first plugin can be both exciting and intimidating. Is my plugin good enough? Will people download it? What the heck is subversion!?
Take a breath, and just follow this tutorial 🙂
This guide is meant to be a resource for plugin developers trying to get their first plugin published successfully on the WordPress.org Plugin Repository.
How to Get Approved
Getting approved to be added to the repository isn’t hard. All you need to do is follow the rules and use your best judgement. Here are some articles that will help guide you on your path to approval.
- Guidlines listed here
- The Expanded Guidelines
- check here if any of the guidelines are unclear to you
- Advice from a Plugin Moderator
- Example readme.txt file with instructions
- Approval can take anywhere from 6 hours to 6 days, be patient!
- You don’t need a page on your site explaining your plugin if you host it on the repository
- Don’t forget to add a readme.txt that is up to standards
- Readme validator
- The readme validator will find any errors or missing information in your readme.txt. Not all sections, like a donation link, need to be present in order to get approved.
How to Add a WordPress Plugin
Once you’re sure your plugin is up to standards and adheres to the guidelines, you can submit it to the official repository.
- Search the repository for your plugin’s name to make sure it doesn’t already exist
- If you get an error telling you that your plugin already exists in the repository and it does not, this means you are using a banned word. Most likely, you will have to remove the word “WordPress” because it is a banned word.
- Use a gravatar email to have your image show up on WordPress.org
- No tools needed here 🙂
How to Use Subversion
Once you get approved, your plugin will appear here plugins.svn.wordpress.org. Now, you’ll need to use the subversion system in order to add your plugin files.
- How to Use Subversion
- SVN Repository FAQ
- How to add your plugin to the repository
- Chris Coyier shows you how to use the Command Prompt to upload your plugin
- A step-by-step video tutorial on uploading your plugin
- This video tutorial shows you how to use Tortoise to add your plugin
- It also includes how to update your plugin to a new version
- How to update your plugin
(I included a few tutorials here in case any individual article isn’t clear enough)
- When logging in, your username is case-sensitive. Make sure you enter your name properly or you will get an error every time
- After uploading your files, your plugin will appear in the repository in 5-15 minutes.
- Tortoise SVN
- Provides Windows users with a GUI for subversion
- Provides Mac users with a GUI for subversion
- Another alternative for Mac users
If you have any other resources, tips, or tools that would make this guide even more helpful for first-time plugin publishers, leave a comment or contact us via the contact form.