A Complete Guide to Submit Your Plugins to WordPress.org
WordPress repository has more 50,000 plugins in its repository that covers all the essential features and functionalities for your powerful website. The figure that WordPress incorporates shows that there are plugins that you require for every feature you needed on your WordPress website.
This number is regularly increasing at a rapid pace. These plugins are either free and premium. The user can use according to the requirement and budget. And are licensed in the General Public License (GPL).
But, several plugins are published by the experts in the WordPress Plugin Directory. The reason behind this is that they do not find a suitable plugin to fit-in their needs.
There are chances that you might also have faced this issue. Plugins make it more accessible for the users to integrate the features to their website without any technical expertise. It reduces a lot of work at your end.
Have you ever thought to create the one?
Why not take advantage of sharing the plugins with the entire WordPress community?
Here, in this article, we will provide you with a comprehensive guide on how and why to create your own plugin in WordPress.org?
So, let’s get started without any further delay!!
Why Publishing a Plugin is Advantageous?
Though, the reasons for publishing plugins vary for every business requirement. But, we have researched some general reasons that specify that owning plugin is beneficial. Find out below:
- There might be a need of adding functionality in the plugin, which is not present in the directory.
- The opportunity that a competitive market is revealing
- Requirement of creating a community in the custom plugin
- The coveted plugin is not giving the functionality that you expect.
- Some of these plugins can charge you for the more extensions and can annoy you as well.
- Sometimes, some simplified functionalities are required that do not exist in the directory.
- You also want to be a part of the WordPress community and give your contribution towards it.
Other than the above, there is:
- Regular Support
After being a part of the WordPress community, you can ask to rate and review the plugin. The repository also demands support from the interface. That implies there is not an issue of managing the support externally.
- Update Alerts
The repository can also send alerts to the users about the regular plugin updates. This is also helpful in adding features and fixing bugs.
- Version Control
Maintaining a history of every WordPress plugin is also possible. You can also cooperate on it with some other developers with the Subversion (It is the control software distributed on WordPress repository servers).
** Subversion version control**
The execution of subversion control commands from the command line on OSX ( Version 10 of Apple Macintosh OS) where it is installed fundamentally. There is a subversion plugin- Subclipse that can also be downloaded. Additionally, Windows Subversion client- Tortoise SVN is also an option.
Discovering some errors is easy for WordPress developers than mastering the Subversion. Below the subversion vocabulary is given, have a look:
- It is the central platform to retrieve and story work.
- The information is available to every WordPress developer.
- Integrated to theme and plugin update
Trunk: Meant for the active development
- Incorporates every single version of the WordPress plugin.
- The versions should be numbered with three digits, such as 2 (major rewrite).2 (feature update of the plugin).0 (bug fix).
- Developed to check out the process of plugin development.
- The changes and updates can be transcribed locally.
- For your convenience, it copies the tags, assets, and truck locally.
- This process happened when the updates-testing method completes.
- Pushing the new version with the updated tag to publish to the repository.
- Precisely, If your tag update in reade.txt file is greater than the plugin version on the client’s installation, then the community notifies that a new plugin is available to install.
Why Choose WordPress Plugin Directory?
- Take the benefits of several excellent services and tools (statistics, plugin description, support form changelog, active installs, etc.) for free.
- You get notified every time whenever a new version is available and can get updated from the WordPress plugin screen directly.
- Higher visibility in all search engines (Google, Yandex, Yahoo, and Bing).
- Stable medium to promote the identity and to grow your status as the developer.
- Exceptional method to generate loose traffic and eyeballs on your plugin.
Submit to the WordPress Plugin Directory
Before checking the submission process of WordPress plugin, you need to look after the below guidelines:
- Assure that your plugin is GPL compatible.
- User consent is required before storing the user credentials.
- Not spamming users.
- Do not include confusing code.
- Stay yourself away from illegal and substantially offensive ideas.
- Do not include the external links in the public website.
Now, let’s take a look at the points that can help you to create a plugin for yourself.
Step 1: Check out the Plugin in the WordPress Repository
Go to WordPress.org. Write your coveted plugin name in the Search plugin – Input.
If it does not exist, then are chances still that the plugin with the same is there with the same name. The only thing which is not letting it displayed is: the Subversion commit is not submitted. So, it is better to choose a unique and exclusive name.
Step 2: Generate a Plugin That Works
Since there is not a standard or official framework to create a plugin, but the one that is used in many cases is- WordPress Plugin- Boilerplate or DeviVison. It is perfect and meant for more substantial projects.
After the creation of the plugin, you need to update the code and test all the functionalities several times to ensure the proper functioning of every part.
Step 3: Justify the Readme file
This file is utilized for putting in the plugin’s WordPress Plugin Directory page. Here, you need to give:
- plugin name
- contributors (WordPress author IDs)
- donate link
- suitable WordPress version
- license (GPL)
- plugin short description
Choose the tags according to the listed in the popular tags and the competing plugin which is suitable for the plugin. These can be discovered from the competing plugin on the directory page by scrolling to the page bottom or by finding the readme.txt file.
After filling in the information, add the installation instructions, main description, plugin screenshots and the FAQ. Do not forget to integrate the icon, banner, and screenshots in the plugin asset repository. It will be better if you add more screenshots. After getting satisfied with the readme file, execute it from the ReadMe Validator.
Step 4: Submit Plugin for Review
After getting done with the above mentioned steps, submit the plugin for the manual review. For that, it is required to create a WordPress account.
Follow the link to add the plugin. Add the plugin description. For the plugin URL, compress the plugin files, upload the plugin.zip file to your WordPress website.
Here, assure that you can upload the compressed file to the Google Drive and to the compressed file. Integrate the public link to the plugin zip file.
Step 5: Waiting for Approval
The plugins of WordPress Plugin Directory are reviewed manually. The approval can be given in some amount of time. The maximum time it takes is 8 hours for the revision and approval.
Step 6: Request approval
The approval mail is sent from the WordPress community. It assures whether the plugin is approved or not!!
Step 7: Storing the plugin in the WordPress Subversion repository
When the plugin is approved, the storage of the plugin is done in the WordPress Subversion Repository. It is the place where are plugins are stored. The changes can be done only by the contributors in the readme file. But, anyone can take your plugin copy from the WordPress repository.
The plugin can be stored in two sets of instructions, one is for those who are using the Windows, and the other is for the Mac. Here, we are discussing the reliable one.
The storage of the plugin is in the WordPress.org SVN repository. The check out can be done by anyone, but the check-in is accessible only to the author.
After navigating to the parent directory, run the command in the terminal window. It integrates the central WordPress subversion repository in the local repository.
The response will be in the form of:
Reject, Accept (temporary or permanent)?
It displays that the wpmerchant directory is added in the PC. Th assets, branches and trunk directory were previously added in the wpmerchant Subversion repository directory. After having the files in the trunk directory, add the files in the subversion repository for tracking. Use the command line below to get it done.
Change it to the central repository by:
And is done!! Check the WordPress Plugin directory page, and now you can see your uploaded image.
After publishing the plugin, new files, editing, or deleting the existing files on the local machines, the change uploading process on the server proceeds. These changes are tracked by the sub-version so that you can get back on the existing version and can revise later.
SVN directory has four default folders, namely:
- Assets: It holds headers, screenshots, and icons.
- Trunk: The directory in which the plugins are stored.
- Branches: It contains Different branches of code.
- Tags: The storage of plugins lies in tags.
Every plugin should have at least two files, namely, main PHP script and readme.txt. Also, you can amalgamate the assets (images) so that it can be shown to the plugin’s page.
Let’s discuss every default folder in detail.
- These are the plugin icon, header, and screenshot.
- The headers are PNG or JPG images that can be seen at the top of the plugin page.
- The name of the files is dependent on the image height and width.
Recently, the below dimension and names are allowed in the plugin assets.
- Regular: Banner-7724X540.png/jpg
The icons are in the square form with the below dimensions and names:
The images can be scaled at any size; therefore, there is no need to specify the SVG dimensions in the file name. If there is a usage of SVG, then providing a PNG icon is necessary.
If we talk about the screenshots, then these are the images displayed on the plugin page content. Only JPEG and PNG formats are permitted. The file name should be lowercase and check out the below structure:
- Screenshot-1.png or jpg
- Screenshot-2.png or jpg
There should be a detailing of every screenshot in the readme file. The graphics should be integrated in the assets folder in the local plugin directory. You can check the working of the plugin asset in this link.
Plugin Header Comment
The header is here to notify WordPress that a file is a plugin.
Now, you have planned to submit the plugin then, it is recommended that the more information you add and the better the plugin functionality it will be. We have created a list of accessible fields:
- Plugin name: The name should be unique. Assure that the name you have decided is not the list already.
- Plugin URL: Plugin home page
- Version: Current plugin version or higher (if available).
- Description: Not more than 140 characters.
- Author URL: Author’s home page
- Author: one or more author-name; divided by commas
- License: Plugin’s license slug
- Text domain: Plugin’s text domain
- License URL: Link to the complete text of the license.
- Domain path: The path to find the translation files
The plugin should be provided with the readme.txt file with the suitable headers in the main script. The readme.txt file is required with the below information:
- Plugin name
- Donate link
- Requires at least
- Stable tag
- Tested up to
- License URI
Now, you have a comprehensive guide on the plugin submission process in WordPress. Org. Follow them to create one for yourself. Be different and captivated. Choose the best platform (WordPress) to promote and distribute your exceptional work.
If you have contemplated this before, then share your experience with us. Share your queries and suggestions in the comment section below. If we have missed something, then let us know.
Hopefully, you enjoyed this article. Thanks for reading!!