• Main
• Community
• Documentation
• Forum
• Extensions
• Shop
• Developers

These pages are automatically generated by the phpDocumentor package from an analysis of the Joomla! source code and making use of specially formatted comments embedded in the source code itself.

The Joomla! Content Management System (CMS) is an application built on top of the Joomla! Framework. This website documents the API of the Joomla! Framework and so does not include code from the Joomla! CMS. In particular, the legacy API is now implemented in a plug-in which is part of the CMS and so is no longer documented here.

This is what you will find here:

• The Joomla! Framework API, called simply Joomla-Framework.
• A number of third-party libraries used by Joomla! and/or available for use by third-party Joomla! extension developers. Please note that the Joomla! Developer Documentation Team is not responsible for maintaining documentation, including this automatically generated documentation, for third-party libraries.

You can select which package to view using the drop-down list in the menu on the left of this screen.

Third-party libraries are documented here for completeness and because they contain valuable information not available elsewhere. However, to get the best out of the Joomla! Framework, please try to use the Joomla! API calls in preference to calling the libraries directly.

Additional documentation is available on the Joomla! Documentation Wiki website and in particular there is a manually produced API reference which has additional information and example code for classes and methods in the Joomla! Framework.

You can download a copy of this website for offline use (subject to the terms of the Joomla! Electronic Documentation License) from here.

Symbol	Description	Symbol	Description	Symbol	Description
	Class		Method		Variable
	Private class		Private method		Private variable
	Abstract class		Abstract method		Static variable
	Abstract private class				Global
			Static method		Constant
	File folder		Constructor
	Class folder		Destructor		File
	Function folder		Function		Index
	Tutorial folder				Tutorial
	Package folder				Subpackage

If you notice any errors on any of these pages then please take a moment to report the problem on the Developer Documentation Forum.