2.11.9 User Guide

Retired Documentation

You are using the documentation for version 2.11.9. Go here for the latest version or check here for your available upgrades to the latest version.



To facilitate quality third-party add-ons, EllisLab has defined the following programming guidelines. Even if you do not plan on publicly releasing your add-on, you will greatly benefit from the security, performance tips, and uniformity of code that results from following these guidelines.

Some things may be different from your current coding style, but it is important to remember that you rarely will be the only person working with the code. Consistency makes it easier for other developers to follow. And memories fade, so that “other developer” may simply be you, six months later!


The following areas discuss the various requirements for having your add-on approved by EllisLab for inclusion in the Add-On Library. A checklist is also provided to assist you in quickly reviewing your code to see that the guidelines are met before submitting your add-on.


Unless otherwise indicated, each item discussed is a requirement, and not an option for consideration.

After reading and understanding the above sections, you can use the Summarized Checklist to assist you in reviewing your code prior to submission.


Templates are available to assist you in documenting your add-on.