Submitting an extension to the Joomla! Extension Directory™ (JED) is a straightforward process that enables developers to share their creations with the Joomla community. Given that there are over 5,000 extensions currently listed, making a contribution can significantly enhance both your visibility and that of your work. This article details the necessary steps, from registration through to submission, and highlights key considerations to ensure your extension meets the platform's requirements.
TL:DR – The process of submitting an extension to the Joomla Extension Directory involves registering on the platform, completing a submission form, and ensuring adherence to necessary requirements for approval. This guide provides a comprehensive overview using our recent experience and shows how to successfully complete the submission process. You can find the plugin in the JED by searching for Automatic Meta Description (Joomla Extensions Directory), and the source code is in GitHub at Autometa (GitHub)
Contents
- Building and publishing the extension
- The registration process
- Preparing for submission by testing your extension
- Submitting the extension
- The post-submission process
- Best practices for submissions
- Successful submission
- Promoting your extension
- Ensuring security and updates
- Conclusion
- Alternative titles
Building and publishing the extension
The starting point for submitting this extension was creating it to meet a need I had for this website, automating Meta Description. So you might want to review the articles I wrote about Creating a Joomla plugin and component with a little help from AI and subsequently about how I moved to Automating publication of a Joomla Plugin using an update server - these were crucial steps to take before considering submitting the plugin to the JED. I've also been testing the plugin on my sites for several weeks because the JED isn't for beta software its for production quality software. I realise my plugin is quite limited, but nevertheless it has a set of use cases/user stories and it is potentially disruptive so it needs to be properly tested on a variety of Joomla sites before publication. Now I am satisfied that it does what it is supposed to, its time to publish it.
The registration process
To initiate the process of submitting an extension to the Joomla Extension Directory, first one must register on the platform. This establishes your account and enables you to manage your submissions and communicate with the JED team. To begin, navigate to the JED website and locate the “Register” button prominently displayed on the homepage. Following this, you will be directed to a registration form.
As you complete the registration form, you need to be meticulous in providing accurate details. You will need to include relevant information such as your name, email address, and possibly additional contact data including your organisation name. After submitting the form, a confirmation email will be dispatched to your registered email address. Upon verifying your email, your registration will be activated, allowing you to proceed with submission.
It is worth noting that while the registration process may seem tedious, it is imperative not to skip any steps. Incomplete or incorrect submissions may cause delays or prevent you from accessing certain features of the JED, including extension submission. Therefore, assure that you review your entries before submission.
Preparing for submission by testing your extension
Prior to submitting your extension, it is crucial to familiarise yourself with the Submission Requirements for the JED. These requirements ensure that submissions meet specific quality and security standards that maintain the integrity of the directory.
Download the JED Checker from the JED itself. JED Checker is an extension that helps you to ensure your extension meets the requirements to be listed in the JED. It is invaluable! You should run this before starting the submission process because if it requires a name change you will have to send a separate ticket after completing the form. Better to get it right first time!
I found this incredibly helpful. My little plugin was in good shape but still it noticed a few detail errors and issues which I was quickly able to fix.
You can see from the table below what it checks. It provides notes where there is an issue. Work through them until you are done.
This is a vital step.
The install name of your extension must match your listing name on JED. We scan the xml files and find the value of the name tag. Useful information for the "filename and install as" fields in the jed submission form
The name tag in this file is: Content - Automatic Meta Description
Version tag has the value: 1.1.28
The creationDate tag has the value: 14 March 2025
An install file should include the license information in a license-tag. The license must be GPL or GPL compatible.
Validation of extension's XML manifest file
Check for incorrect files and folders references in the XML manifest
The use of Update Servers is now required by JED.
The Update Server link in this XML file is: https://www.multizone.co.uk/updates/autometa.xml
A notice is required on each PHP file stating that the file is licensed GPL (or other compatible accepted license). For more information, please click here.
GPL license was found
@license GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
PHP Files missing JEXEC security
All the PHP files in your extension needs to have a defined('_JEXEC') or die(); statement in the beginning of each file. This ensures that the file cannot be opened outside of the joomla installation and increases the security of your site.
Joomla Framework deprecated and unsafe
Warns about
- superglobals
- commonly used but deprecated functions
- highly unsafe functions
Use of error_reporting(0) is discouraged as Joomla provides an error_reporting option in the Global Configuration.
As developers we are fully aware that the base64 and similar functions have a valid place in extensions (such as URL redirects or data storage). However if you use those to make it harder for users to read your code or to mask backlinks the JED will not accept your listing submission (this is not in the spirit of GPL anyway!). An editor will review your code and determine if the way you use the base64 matches the rules of the JED. This might slow your listing review time. So the rule of thumb is - don't do fishy stuff and avoid encoding your code if possible!
JAMSS will raise many flags for use of potentially dangerous methods, additionally checking for some known attack signatures. Find out more on the Project's homepage
JAMSS output is very verbose and very useful, hover over any lines to see the details.
Validates language files
Submitting the extension
After successful testing with JED Checker, log in to your JED profile page using your newly created credentials. On this page, look for the "Submit extension" button, which is your gateway to adding your extension to the JED. You can see how to do this on the JED Documentation site.
Once you click on the "Submit extension" button, you will be presented with a detailed submission form. This form will require comprehensive information regarding your extension, including its name, description, version, features, and any applicable licensing details. Take your time to fill in every section meticulously; omissions or inaccuracies can lead to complications during the review process.
While the form might appear overwhelming at first glance, keep in mind that providing a thorough and clear description not only aids the reviewers but can also attract users to your extension. Make sure you hve a good website landing page for your extension, and that it provides documentation, support and demo information that you can link to in the JED. This will help to breathe life into your submission by explaining what makes your extension valuable and why users should consider incorporating it into their Joomla installations.
The post-submission process
Upon completing the submission form, ensure you click the "Save" button to finalise your submission. If all information is filled out correctly, you will receive a notification informing you that your listing is now pending review by the JED team. The waiting period can range from a few days to several weeks, although my little plugin was approved overnight. It depends on the volume of submissions the team is processing at any given time.
During this waiting period, be patient. The JED team is thorough in their review processes, using the JED Checker themselves and aiming to maintain the quality of the extensions listed on the platform. Should there be any issues with your submission, you will be notified with instructions on what needs to be corrected before your extension can proceed to publication.
Regularly check your email for any updates or requests for additional information. Communicating with the JED team, if necessary, can help address any unforeseen challenges that may arise during this period.
Best practices for submissions
As you prepare your extension for submission, there are several best practices to consider that can streamline your process and enhance your submission quality. First and foremost, adhere strictly to the Joomla coding standards. These standards not only ensure compatibility with Joomla's architecture but also promote the maintenance and security of your code.
Moreover, thorough documentation accompanying your extension can significantly improve user experience and facilitate troubleshooting post-release. Users are more likely to engage with well-documented extensions, as it makes the integration process straightforward. Consider including installation guides, usage instructions, and troubleshooting sections within your documentation.
Additionally, testing your extension extensively before submission is vital and should be part of your DevOps process anyway. Engage beta testers who can provide constructive feedback based on their utilisation of your extension. This feedback can also help identify any quirks or bugs in the code that may not be apparent to you. Submitting a polished, bug-free extension will increase your chances of a smooth review process.
Successful submission
Promoting your extension
Upon successful listing in the JED, you can think about marketing your extension. An effective marketing strategy can significantly enhance your visibility and user adoption rates. One key method of promotion is leveraging social media platforms. Share updates, tutorials, and features of your extension across various social channels to engage potential users.
Moreover, connecting with Joomla community forums, user groups, and blogs can provide avenues for promoting your extension. Engaging with these communities not only builds rapport but also allows you to gather further feedback and suggestions, which could be crucial for future updates. Contributing valuable content to these channels can position you as a trusted source within the community.
Furthermore, consider encouraging user reviews and testimonials for your extension. Positive reviews can enhance your reputation while also boosting the confidence of potential users. Provide avenues for users to share their experiences, such as on forums or social media, as this user-generated content can be invaluable in marketing terms.
Ensuring security and updates
Security is paramount in any software application, especially in extensions that will be publicly available within the Joomla Extension Directory. Regularly review your code for vulnerabilities and promptly address any security issues that may arise. Keeping the extension updated not only helps maintain security but also enhances user satisfaction as new features or improvements are introduced.
Moreover, encourage feedback from users regarding their experiences and any potential security concerns they may encounter. A proactive approach to security and updates fosters trust in your extension and encourages users to rely on it long-term. Providing an accessible channel where users can report issues or suggest improvements can facilitate this process.
Finally, engage in conversations about security within the Joomla community. Sharing knowledge and insights can benefit not only your extension but also contribute positively to the overall ecosystem, as it raises awareness about best practices among developers and users alike.
Conclusion
Submitting an extension to the Joomla Extension Directory involves a systematic process starting from registration, following through to the actual submission of your extension, and then navigating post-submission expectations. By adhering to the submission requirements, implementing best practices, and promoting your extension effectively, you can increase the likelihood of your extension's success within the Joomla community.
Create well-documented, secure extensions, and engage actively with your user base. Remember that successful submissions are rooted in quality, communication, and ongoing improvements. Start your journey with confidence, knowing that each step taken in preparation will pay off in the long run.
So, if you have diligently worked on an extension, it's time to take the plunge. Submit your creation to the Joomla Extension Directory today and contribute to the thriving community of Joomla developers and users.
Alternative titles
- A step-by-step guide to submitting your extension on the Joomla Extension Directory
- The ultimate tutorial for Joomla extension submission
- How to efficiently submit your Joomla extension to the JED
- Mastering the Joomla Extension Directory submission process
- Tips for a successful Joomla extension submission
