Joomla! API

<!DOCTYPE html> <html lang="en" dir="ltr"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="apple-mobile-web-app-capable" content="yes" /> <meta name="apple-mobile-web-app-status-bar-style" content="blue" /> <meta name="description" content="The Joomla! API Documentation" /> <meta name="twitter:image" content="https://cdn.joomla.org/images/sharing/joomla-twitter-card.png" /> <meta name="twitter:description" content="The Joomla! API Documentation" /> <meta name="twitter:title" content="Joomla.org" /> <meta name="twitter:card" content="summary_large_image" /> <meta name="twitter:site" content="@joomla" /> <meta property="og:image" content="https://cdn.joomla.org/images/sharing/joomla-org-og.jpg" /> <meta property="og:description" content="The Joomla! API Documentation" /> <meta property="og:title" content="Joomla! API" /> <meta property="og:type" content="article" /> <meta property="og:url" content="https://api.joomla.org" /> <meta property="og:site_name" content="Joomla! API" /> <title>Joomla! API</title> <link href="https://api.joomla.org/images/apple-touch-icon-180x180.png" rel="apple-touch-icon" sizes="180x180" /> <link href="https://api.joomla.org/images/apple-touch-icon-152x152.png" rel="apple-touch-icon" sizes="152x152" /> <link href="https://api.joomla.org/images/apple-touch-icon-144x144.png" rel="apple-touch-icon" sizes="144x144" /> <link href="https://api.joomla.org/images/apple-touch-icon-120x120.png" rel="apple-touch-icon" sizes="120x120" /> <link href="https://api.joomla.org/images/apple-touch-icon-114x114.png" rel="apple-touch-icon" sizes="114x114" /> <link href="https://api.joomla.org/images/apple-touch-icon-76x76.png" rel="apple-touch-icon" sizes="76x76" /> <link href="https://api.joomla.org/images/apple-touch-icon-72x72.png" rel="apple-touch-icon" sizes="72x72" /> <link href="https://api.joomla.org/images/apple-touch-icon-57x57.png" rel="apple-touch-icon" sizes="57x57" /> <link href="https://api.joomla.org/images/apple-touch-icon.png" rel="apple-touch-icon" /> <link href="https://api.joomla.org/images/favicon.ico" rel="shortcut icon" type="image/vnd.microsoft.icon" /> <link href="https://cdn.joomla.org/template/css/template_3.0.0.min.css" rel="stylesheet" /> <link href="https://api.joomla.org/css/overrides.css" rel="stylesheet" /> <link href="https://fonts.googleapis.com/css?family=Open+Sans:400" rel="stylesheet" /> <style> h1, h2, h3, h4, h5, h6 { font-family: 'Open Sans', sans-serif; } </style> <script src="https://code.jquery.com/jquery-1.12.4.min.js"></script> <script src="https://code.jquery.com/jquery-migrate-1.4.1.min.js"></script> <script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script> <script src="https://api.joomla.org/js/template.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.js"></script>  </head> <body class="site">  <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NDWJB8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-NDWJB8');</script>  <nav class="navigation" role="navigation"> <div id="mega-menu" class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> <div class="container"> <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </a> <div class="nav-collapse collapse"> <ul id="nav-joomla" class="nav"> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#"> <span dir="ltr"><span aria-hidden="true" class="icon-joomla"></span> Joomla!<sup>®</sup></span> <span class="caret"></span> </a> <ul class="dropdown-menu"> <li class="nav-header"><span>About us</span></li> <li> <a href="https://www.joomla.org"> <span aria-hidden="true" class="icon-joomla"></span> Joomla Home </a> </li> <li><a href="https://www.joomla.org/about-joomla.html">What is Joomla?</a></li> <li><a href="https://www.joomla.org/core-features.html">Benefits & Features</a></li> <li><a href="https://www.joomla.org/about-joomla/the-project.html">Project & Leadership</a></li> <li><a href="https://tm.joomla.org">Trademark & Licensing</a></li> <li><a href="https://foundation.joomla.org">The Joomla Foundation</a></li> <li class="divider"></li> <li class="nav-header"><span>Support us</span></li> <li><a href="https://www.joomla.org/contribute-to-joomla.html">Contribute</a></li> <li><a href="https://www.joomla.org/sponsor.html">Sponsor</a></li> <li><a href="https://www.joomla.org/about-joomla/partners.html">Partner</a></li> <li><a href="https://shop.joomla.org">Shop</a></li> </ul> </li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Download & Extend <span class="caret"></span></a> <ul class="dropdown-menu"> <li><a href="https://downloads.joomla.org">Downloads</a></li> <li><a href="https://extensions.joomla.org">Extensions</a></li> <li><a href="https://community.joomla.org/translations.html">Languages</a></li> <li><a href="https://launch.joomla.org">Get a free site</a></li> </ul> </li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Discover & Learn <span class="caret"></span></a> <ul class="dropdown-menu"> <li><a href="https://docs.joomla.org">Documentation</a></li> <li><a href="https://training.joomla.org">Training</a></li> <li><a href="https://certification.joomla.org">Certification</a></li> <li><a href="https://showcase.joomla.org">Site Showcase</a></li> <li><a href="https://www.joomla.org/announcements.html">Announcements</a></li> <li><a href="https://community.joomla.org/blogs.html">Blogs</a></li> <li><a href="https://magazine.joomla.org">Magazine</a></li> </ul> </li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Community & Support <span class="caret"></span></a> <ul class="dropdown-menu"> <li><a href="https://community.joomla.org">Community Portal</a></li> <li><a href="https://community.joomla.org/events.html">Events</a></li> <li><a href="https://community.joomla.org/user-groups.html">User Groups</a></li> <li><a href="https://forum.joomla.org">Forum</a></li> <li><a href="https://resources.joomla.org">Resources Directory</a></li> <li><a href="https://volunteers.joomla.org">Volunteers Portal</a></li> <li><a href="https://vel.joomla.org">Vulnerable Extensions List</a></li> </ul> </li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Developer Resources <span class="caret"></span></a> <ul class="dropdown-menu"> <li><a href="https://developer.joomla.org">Developer Network</a></li> <li><a href="https://developer.joomla.org/security.html">Security Centre</a></li> <li><a href="https://issues.joomla.org">Issue Tracker</a></li> <li><a href="https://github.com/joomla">GitHub</a></li> <li><a href="https://api.joomla.org">API Documentation</a></li> <li><a href="https://framework.joomla.org"><span dir="ltr">Joomla!</span> Framework</a></li> <li><a href="http://joomlacode.org">JoomlaCode</a></li> </ul> </li> </ul> <div id="nav-search" class="navbar-search pull-right"> <form action="https://api.joomla.org/results.html" id="searchbox_007628682600509520926:myhvbnm964o" class="form-search"> <input type="text" name="q" id="api-google-search" class="search-query input-medium" size="20" placeholder="Search ..." autocomplete="off"> <input type="hidden" name="cx" value="007628682600509520926:myhvbnm964o"> <input name="siteurl" type="hidden" value="api.joomla.org/"> <input name="ref" type="hidden" value="api.joomla.org/"> <input name="ss" type="hidden" value=""> </form> </div> </div> </div> </div> </div> </nav> <header class="header"> <div class="container"> <div class="row-fluid"> <div class="span7"> <h1 class="page-title"><a href="https://api.joomla.org">Joomla! API</a></h1> </div> <div class="span5"> <div class="btn-toolbar pull-right"> <div class="btn-group"> <a href="https://downloads.joomla.org" class="btn btn-large btn-warning">Download</a> </div> <div class="btn-group"> <a href="https://launch.joomla.org" class="btn btn-large btn-primary">Launch</a> </div> </div> </div> </div> </div> </header> <div class="subnav-wrapper"> <div class="subnav"> <div class="container"> <ul class="nav menu nav-pills"> <li> <a href="https://api.joomla.org">Joomla! API Index</a> </li> </ul> </div> </div> </div> <div class="body"> <div id="___" class="container"> <noscript> <div class="alert alert-warning"> Javascript is disabled; several features are only available if Javascript is enabled. </div> </noscript> <div class="page-header"> <h1>Joomla! API Documentation</h1> </div> <p class="lead">This site provides an API reference for the Joomla! CMS and Framework releases based on the comments in the source code.</p> <div class="row-fluid"> <main class="span9"> <div class="row-fluid"> <ul class="thumbnails"> <li class="span6"> <div class="thumbnail"><img src="https://api.joomla.org/images/cms.png"> <div class="caption"> <p> <a class="btn btn-large btn-block" href="https://api.joomla.org/cms-5/index.html">CMS 5.x</a> <a class="btn btn-large btn-block" href="https://api.joomla.org/cms-4/index.html">CMS 4.x</a> <a class="btn btn-large btn-block" href="https://api.joomla.org/cms-3/index.html">CMS 3.x</a> <a class="btn btn-large btn-block" href="https://api.joomla.org/cms-2.5/index.html">CMS 2.5</a> </p> </div> </div> </li> <li class="span6"> <div class="thumbnail"><img src="https://api.joomla.org/images/framework.png"> <div class="caption"> <p> <a class="btn btn-large btn-block" href="https://api.joomla.org/framework-3/index.html">Framework 3.x</a> <a class="btn btn-large btn-block" href="https://api.joomla.org/framework-2/index.html">Framework 2.x</a> <a class="btn btn-large btn-block" href="https://api.joomla.org/framework-1/index.html">Framework 1.x</a> </p> </div> </div> </li> </ul> </div> </main> <aside class="span3"> <h3>Additional Resources</h3> <ul class="nav menu nav-stacked nav-tabs"> <li><a href="https://docs.joomla.org">Documentation Wiki</a></li> <li><a href="https://developer.joomla.org/coding-standards.html">Coding Standards Manual</a></li> <li><a href="https://developer.joomla.org/en-gb-user-interface-text-guidelines.html">en-GB User Interface Text Guidelines</a></li> <li><a href="https://github.com/joomla/joomla-cms">Joomla! CMS on GitHub</a></li> <li><a href="https://github.com/joomla-framework">Joomla! Framework on GitHub</a></li> </ul> </aside> </div> </div> </div> <footer class="footer center"> <div class="container"> <hr /> <div class="social"> <ul class="soc"> <li><a href="https://twitter.com/joomla" target="_blank" rel="noopener" class="icon-twitter2" title="Joomla! on Twitter"><span class="element-invisible">Joomla! on Twitter</span></a></li> <li><a href="https://www.facebook.com/joomla" target="_blank" rel="noopener" class="icon-facebook2" title="Joomla! on Facebook"><span class="element-invisible">Joomla! on Facebook</span></a></li> <li><a href="https://www.youtube.com/user/joomla" target="_blank" rel="noopener"class="icon-youtube3" title="Joomla! on YouTube"><span class="element-invisible">Joomla! on YouTube</span></a></li> <li><a href="https://www.linkedin.com/company/joomla" target="_blank" rel="noopener" class="icon-linkedin" title="Joomla! on LinkedIn"><span class="element-invisible">Joomla! on LinkedIn</span></a></li> <li><a href="https://www.pinterest.com/joomla" target="_blank" rel="noopener" class="icon-pinterest2" title="Joomla! on Pinterest"><span class="element-invisible">Joomla! on Pinterest</span></a></li> <li><a href="https://www.instagram.com/joomlaofficial/" target="_blank" rel="noopener" class="icon-instagram" title="Joomla! on Instagram"><span class="element-invisible">Joomla! on Instagram</span></a></li> <li><a href="https://github.com/joomla" target="_blank" rel="noopener" class="icon-github3" title="Joomla! on GitHub"><span class="element-invisible">Joomla! on GitHub</span></a></li> </ul> </div> <p>Documentation is powered by <a href="http://www.phpdoc.org">phpDocumentor</a>.</p> <div class="footer-menu"> <ul class="nav-inline"> <li><a href="https://www.joomla.org"><span>Home</span></a></li> <li><a href="https://www.joomla.org/about-joomla.html"><span>About</span></a></li> <li><a href="https://community.joomla.org"><span>Community</span></a></li> <li><a href="https://forum.joomla.org"><span>Forum</span></a></li> <li><a href="https://extensions.joomla.org"><span>Extensions</span></a></li> <li><a href="https://community.joomla.org/service-providers-directory.html"><span>Services</span></a></li> <li><a href="https://docs.joomla.org"><span>Docs</span></a></li> <li><a href="https://developer.joomla.org"><span>Developer</span></a></li> <li><a href="https://community.joomla.org/the-joomla-shop.html"><span>Shop</span></a></li> </ul> <ul class="nav-inline"> <li><a href="https://www.joomla.org/accessibility-statement.html">Accessibility Statement</a></li> <li><a href="https://www.joomla.org/privacy-policy.html">Privacy Policy</a></li> <li><a href="https://www.joomla.org/cookie-policy.html">Cookie Policy</a></li> <li><a href="https://community.joomla.org/sponsorship-campaigns.html">Sponsor Joomla! with $5</a></li> <li><a href="https://joomla.crowdin.com" target="_blank" rel="noopener">Help Translate</a></li> <li><a href="https://github.com/joomla/joomla-websites/issues/new?title=%5Bjapi%5D%20">Report an Issue</a></li> </ul> <p class="copyright">© 2005 <a href="https://opensourcematters.org">Open Source Matters, Inc.</a> All Rights Reserved.</p> <div class="hosting"> <div class="hosting-image"><a href="https://www.rochen.com/joomla-hosting" rel="noopener" target="_blank"><img class="rochen" width="84" height="42" src="https://cdn.joomla.org/rochen/rochen_footer_logo_white.png" alt="Rochen" /></a></div> <div class="hosting-text"><a href="https://www.rochen.com/joomla-hosting" rel="noopener" target="_blank"><span dir="ltr">Joomla!</span> Hosting by Rochen</a></div> </div> </div> </div> </footer> </body> </html>

CINXE.COM

Joomla! API