-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathindex.html
More file actions
290 lines (279 loc) · 23 KB
/
Copy pathindex.html
File metadata and controls
290 lines (279 loc) · 23 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
<!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_4.0.9.min.css" rel="stylesheet" />
<link href="css/joomla-fontawesome.min.css" rel="stylesheet" />
<link href="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="js/jquery-1.12.4.min.js"></script>
<script src="js/collapse.min.js" type="module"></script>
<script src="js/dropdown.min.js" type="module"></script>
<script src="js/template.js"></script>
</head>
<body class="site">
<!-- Google Tag Manager -->
<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>
<!-- End Google Tag Manager -->
<nav class="navigation" role="navigation" aria-label="Cross Site Menu">
<div id="mega-menu" class="navbar navbar-expand-md py-md-1">
<div class="container-xxl">
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#primaryMenu" aria-controls="primaryMenu" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="navbar-collapse collapse" id="primaryMenu">
<ul id="nav-joomla" class="navbar-nav">
<li class="dropdown">
<button type="button" class="btn dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
<span dir="ltr"><span aria-hidden="true" class="fab fa-joomla"></span> Joomla!<sup>®</sup></span> <span class="caret"></span>
</button>
<ul class="dropdown-menu">
<li class="dropdown-item nav-header"><span>About us</span></li>
<li>
<a class="dropdown-item" href="https://www.joomla.org">
<span aria-hidden="true" class="icon-joomla"></span> Joomla Home
</a>
</li>
<li><a class="dropdown-item" href="https://www.joomla.org/about-joomla.html">What is Joomla?</a></li>
<li><a class="dropdown-item" href="https://www.joomla.org/core-features.html">Benefits & Features</a></li>
<li><a class="dropdown-item" href="https://www.joomla.org/about-joomla/the-project.html">Project & Leadership</a></li>
<li><a class="dropdown-item" href="https://tm.joomla.org">Trademark & Licensing</a></li>
<li><a class="dropdown-item" href="https://joomlafoundation.org">The Joomla Foundation</a></li>
<li class="dropdown-divider"></li>
<li class="dropdown-item nav-header"><span>Support us</span></li>
<li><a class="dropdown-item" href="https://www.joomla.org/contribute-to-joomla.html">Contribute</a></li>
<li><a class="dropdown-item" href="https://www.joomla.org/sponsor.html">Sponsor</a></li>
<li><a class="dropdown-item" href="https://www.joomla.org/about-joomla/partners.html">Partner</a></li>
<li><a class="dropdown-item" href="https://shop.joomla.org">Shop</a></li>
</ul>
</li>
<li class="dropdown">
<button type="button" class="btn dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Download & Extend <span class="caret"></span>
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="https://downloads.joomla.org">Downloads</a></li>
<li><a class="dropdown-item" href="https://extensions.joomla.org">Extensions</a></li>
<li><a class="dropdown-item" href="https://community.joomla.org/translations.html">Languages</a></li>
<li><a class="dropdown-item" href="https://launch.joomla.org">Get a free site</a></li>
<li><a class="dropdown-item" href="https://domains.joomla.org">Get a domain</a></li>
</ul>
</li>
<li class="dropdown">
<button type="button" class="btn dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Discover & Learn <span class="caret"></span>
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="https://docs.joomla.org">Documentation</a></li>
<li><a class="dropdown-item" href="https://community.joomla.org/joomla-training.html">Training</a></li>
<li><a class="dropdown-item" href="https://certification.joomla.org">Certification</a></li>
<li><a class="dropdown-item" href="https://showcase.joomla.org">Site Showcase</a></li>
<li><a class="dropdown-item" href="https://www.joomla.org/announcements.html">Announcements</a></li>
<li><a class="dropdown-item" href="https://community.joomla.org/blogs.html">Blogs</a></li>
<li><a class="dropdown-item" href="https://magazine.joomla.org">Magazine</a></li>
</ul>
</li>
<li class="dropdown">
<button type="button" class="btn dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Community & Support <span class="caret"></span>
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="https://community.joomla.org">Community Portal</a></li>
<li><a class="dropdown-item" href="https://community.joomla.org/events.html">Events</a></li>
<li><a class="dropdown-item" href="https://community.joomla.org/user-groups.html">User Groups</a></li>
<li><a class="dropdown-item" href="https://forum.joomla.org">Forum</a></li>
<li><a class="dropdown-item" href="https://community.joomla.org/service-providers-directory.html">Service Providers Directory</a></li>
<li><a class="dropdown-item" href="https://volunteers.joomla.org">Volunteers Portal</a></li>
<li><a class="dropdown-item" href="https://extensions.joomla.org/vulnerable-extensions/vulnerable/">Vulnerable Extensions List</a></li>
</ul>
</li>
<li class="dropdown">
<button type="button" class="btn dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Developer Resources <span class="caret"></span>
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="https://developer.joomla.org">Developer Network</a></li>
<li><a class="dropdown-item" href="https://developer.joomla.org/security.html">Security Centre</a></li>
<li><a class="dropdown-item" href="https://issues.joomla.org">Issue Tracker</a></li>
<li><a class="dropdown-item" href="https://github.com/joomla">GitHub</a></li>
<li><a class="dropdown-item" href="https://api.joomla.org">API Documentation</a></li>
<li><a class="dropdown-item" href="https://framework.joomla.org"><span dir="ltr">Joomla!</span> Framework</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</nav>
<header class="header">
<div class="container-md">
<div class="row">
<div class="col-md-7">
<h1 class="page-title">
<a href="https://api.joomla.org">Joomla! API</a>
</h1>
</div>
<div class="col-md-5">
<div class="btn-toolbar pt-md-1 row">
<div class="btn-group col-6">
<a href="https://downloads.joomla.org/" class="btn btn-lg btn-warning">Download</a>
</div>
<div class="btn-group col-6">
<a href="https://launch.joomla.org" class="btn btn-lg btn-primary">Launch<span aria-hidden="true" class="icon-rocket"></span></a>
</div>
</div>
</div>
</div>
</div>
</header>
<div class="subnav-wrapper" style="top: 50px;">
<div class="subnav">
<div class="container-md">
<ul class="nav menu nav-pills">
<li class="nav-item default current active">
<a class="nav-link" 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">
<main class="col-md-9 row row-cols-1 row-cols-md-2 g-4">
<div class="col">
<div class="card">
<img class="card-img-top" src="https://api.joomla.org/images/cms.png" alt="Joomla CMS">
<ul class="list-group list-group-flush">
<li class="list-group-item d-grid"><a class="btn btn-lg" href="https://api.joomla.org/cms-6/index.html">CMS 6.x</a></li>
<li class="list-group-item d-grid"><a class="btn btn-lg" href="https://api.joomla.org/cms-5/index.html">CMS 5.x</a></li>
<li class="list-group-item d-grid"><a class="btn btn-lg" href="https://api.joomla.org/cms-4/index.html">CMS 4.x</a></li>
<li class="list-group-item d-grid"><a class="btn btn-lg" href="https://api.joomla.org/cms-3/index.html">CMS 3.x</a></li>
<li class="list-group-item d-grid"><a class="btn btn-lg" href="https://api.joomla.org/cms-2.5/index.html">CMS 2.5</a></li>
</ul>
</div>
</div>
<div class="col">
<div class="card">
<img class="card-img-top" src="https://api.joomla.org/images/framework.png" alt="Joomla Framework">
<ul class="list-group list-group-flush">
<li class="list-group-item d-grid"><a class="btn btn-lg" href="https://api.joomla.org/framework-4/index.html">Framework 4.x</a></li>
<li class="list-group-item d-grid"><a class="btn btn-lg" href="https://api.joomla.org/framework-3/index.html">Framework 3.x</a></li>
<li class="list-group-item d-grid"><a class="btn btn-lg" href="https://api.joomla.org/framework-2/index.html">Framework 2.x</a></li>
<li class="list-group-item d-grid"><a class="btn btn-lg" href="https://api.joomla.org/framework-1/index.html">Framework 1.x</a></li>
</ul>
</div>
</div>
</main>
<aside class="col-md-3">
<h3>Additional Resources</h3>
<ul class="list-group nav menu nav-stacked nav-tabs">
<li class="list-group-item"><a href="https://docs.joomla.org">Documentation Wiki</a></li>
<li class="list-group-item"><a href="https://developer.joomla.org/coding-standards.html">Coding Standards Manual</a></li>
<li class="list-group-item"><a href="https://developer.joomla.org/en-gb-user-interface-text-guidelines.html">en-GB User Interface Text Guidelines</a></li>
<li class="list-group-item"><a href="https://github.com/joomla/joomla-cms">Joomla! CMS on GitHub</a></li>
<li class="list-group-item"><a href="https://github.com/joomla-framework">Joomla! Framework on GitHub</a></li>
</ul>
</aside>
</div>
</div>
</div>
<footer class="footer text-center">
<div class="container">
<hr>
<p>Documentation is powered by <a href="http://www.phpdoc.org">phpDocumentor</a>.</p>
<div class="social">
<ul class="soc">
<li><a href="https://twitter.com/joomla" target="_blank" rel="noopener" title="Joomla! on Twitter"><span aria-hidden="true" class="fab fa-twitter"></span><span class="visually-hidden">Joomla! on Twitter</span></a></li>
<li><a href="https://www.facebook.com/joomla" target="_blank" rel="noopener" title="Joomla! on Facebook"><span aria-hidden="true" class="fab fa-facebook"></span><span class="visually-hidden">Joomla! on Facebook</span></a></li>
<li><a href="https://www.youtube.com/user/joomla" target="_blank" rel="noopener" title="Joomla! on YouTube"><span aria-hidden="true" class="fab fa-youtube"></span><span class="visually-hidden">Joomla! on YouTube</span></a></li>
<li><a href="https://www.linkedin.com/company/joomla" target="_blank" rel="noopener" title="Joomla! on LinkedIn"><span aria-hidden="true" class="fab fa-linkedin"></span><span class="visually-hidden">Joomla! on LinkedIn</span></a></li>
<li><a href="https://www.pinterest.com/joomla" target="_blank" rel="noopener" title="Joomla! on Pinterest"><span aria-hidden="true" class="fab fa-pinterest"></span><span class="visually-hidden">Joomla! on Pinterest</span></a></li>
<li><a href="https://www.instagram.com/joomlaofficial/" target="_blank" rel="noopener" title="Joomla! on Instagram"><span aria-hidden="true" class="fab fa-instagram"></span><span class="visually-hidden">Joomla! on Instagram</span></a></li>
<li><a href="https://github.com/joomla" target="_blank" rel="noopener" title="Joomla! on GitHub"><span aria-hidden="true" class="fab fa-github"></span><span class="visually-hidden">Joomla! on GitHub</span></a></li>
</ul>
</div>
<div class="footer-menu">
<nav class="navbar navbar-expand">
<div class="container-fluid">
<ul class="navbar-nav mx-auto flex-wrap">
<li class="nav-item"><a class="nav-link" href="https://www.joomla.org"><span>Home</span></a></li>
<li class="nav-item"><a class="nav-link" href="https://www.joomla.org/about-joomla.html"><span>About</span></a></li>
<li class="nav-item"><a class="nav-link" href="https://community.joomla.org"><span>Community</span></a></li>
<li class="nav-item"><a class="nav-link" href="https://forum.joomla.org"><span>Forum</span></a></li>
<li class="nav-item"><a class="nav-link" href="https://extensions.joomla.org"><span>Extensions</span></a></li>
<li class="nav-item"><a class="nav-link" href="https://community.joomla.org/service-providers-directory.html"><span>Services</span></a></li>
<li class="nav-item"><a class="nav-link" href="https://docs.joomla.org"><span>Docs</span></a></li>
<li class="nav-item"><a class="nav-link" href="https://developer.joomla.org"><span>Developer</span></a></li>
<li class="nav-item"><a class="nav-link" href="https://community.joomla.org/the-joomla-shop.html"><span>Shop</span></a></li>
</ul>
</div>
</nav>
<nav class="navbar navbar-expand">
<div class="container-fluid">
<ul class="navbar-nav mx-auto flex-wrap">
<li class="nav-item"><a class="nav-link" href="https://www.joomla.org/accessibility-statement.html">Accessibility Statement</a></li>
<li class="nav-item"><a class="nav-link" href="https://www.joomla.org/privacy-policy.html">Privacy Policy</a></li>
<li class="nav-item"><a class="nav-link" href="https://www.joomla.org/cookie-policy.html">Cookie Policy</a></li>
<li class="nav-item"><a class="nav-link" href="https://community.joomla.org/sponsorship-campaigns.html">Sponsor Joomla! with $5</a></li>
<li class="nav-item"><a class="nav-link" href="https://joomla.crowdin.com" target="_blank" rel="noopener">Help Translate</a></li>
<li class="nav-item"><a class="nav-link" href="https://github.com/joomla/joomla-websites/issues/new?title=[api.joomla.org]%20&body=Please%20describe%20the%20problem%20or%20your%20issue">Report an Issue</a></li>
</ul>
</div>
</nav>
<p class="copyright">© 2005 - 2026 <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" src="https://cdn.joomla.org/rochen/rochen_footer_logo_white.svg" 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 id="adblock-msg" class="alert alert-danger d-none">
<button class="btn-close" data-bs-dismiss="alert" href="#"><span class="visually-hidden">Close</span></button>
<span class="fa fa-triangle-exclamation"></span>
We have detected that you are using an ad blocker. The Joomla! Project relies on revenue from these advertisements so please consider disabling the ad blocker for this domain.
</div>
</div>
</footer>
</body>
</html>