| 1 |
lars |
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
|
3 |
<head>
|
|
|
4 |
|
|
|
5 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
6 |
<title>Plugins : CodeIgniter User Guide</title>
|
|
|
7 |
|
|
|
8 |
<style type='text/css' media='all'>@import url('../userguide.css');</style>
|
|
|
9 |
<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
|
|
|
10 |
|
|
|
11 |
<script type="text/javascript" src="../nav/nav.js"></script>
|
|
|
12 |
<script type="text/javascript" src="../nav/prototype.lite.js"></script>
|
|
|
13 |
<script type="text/javascript" src="../nav/moo.fx.js"></script>
|
|
|
14 |
<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
|
|
|
15 |
|
|
|
16 |
<meta http-equiv='expires' content='-1' />
|
|
|
17 |
<meta http-equiv= 'pragma' content='no-cache' />
|
|
|
18 |
<meta name='robots' content='all' />
|
|
|
19 |
<meta name='author' content='ExpressionEngine Dev Team' />
|
|
|
20 |
<meta name='description' content='CodeIgniter User Guide' />
|
|
|
21 |
|
|
|
22 |
</head>
|
|
|
23 |
<body>
|
|
|
24 |
|
|
|
25 |
<!-- START NAVIGATION -->
|
|
|
26 |
<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
|
|
|
27 |
<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
|
|
|
28 |
<div id="masthead">
|
|
|
29 |
<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
|
|
|
30 |
<tr>
|
|
|
31 |
<td><h1>CodeIgniter User Guide Version 1.7.1</h1></td>
|
|
|
32 |
<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
|
|
|
33 |
</tr>
|
|
|
34 |
</table>
|
|
|
35 |
</div>
|
|
|
36 |
<!-- END NAVIGATION -->
|
|
|
37 |
|
|
|
38 |
|
|
|
39 |
<!-- START BREADCRUMB -->
|
|
|
40 |
<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
|
|
|
41 |
<tr>
|
|
|
42 |
<td id="breadcrumb">
|
|
|
43 |
<a href="http://codeigniter.com/">CodeIgniter Home</a> ›
|
|
|
44 |
<a href="../index.html">User Guide Home</a> ›
|
|
|
45 |
Plugins
|
|
|
46 |
</td>
|
|
|
47 |
<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td>
|
|
|
48 |
</tr>
|
|
|
49 |
</table>
|
|
|
50 |
<!-- END BREADCRUMB -->
|
|
|
51 |
|
|
|
52 |
<br clear="all" />
|
|
|
53 |
|
|
|
54 |
|
|
|
55 |
<!-- START CONTENT -->
|
|
|
56 |
<div id="content">
|
|
|
57 |
|
|
|
58 |
|
|
|
59 |
<h1>Plugins</h1>
|
|
|
60 |
|
|
|
61 |
<p>Plugins work almost identically to <a href="helpers.html">Helpers</a>. The main difference is that a plugin usually
|
|
|
62 |
provides a single function, whereas a Helper is usually a collection of functions. Helpers are also considered a part of
|
|
|
63 |
the core system; plugins are intended to be created and shared by our community.</p>
|
|
|
64 |
|
|
|
65 |
<p>Plugins should be saved to your <dfn>system/plugins</dfn> directory or you can create a folder called <kbd>plugins</kbd> inside
|
|
|
66 |
your <kbd>application</kbd> folder and store them there. CodeIgniter will look first in your <dfn>system/application/plugins</dfn>
|
|
|
67 |
directory. If the directory does not exist or the specified plugin is not located there CI will instead look in your global
|
|
|
68 |
<dfn>system/plugins</dfn> folder.</p>
|
|
|
69 |
|
|
|
70 |
|
|
|
71 |
<h2>Loading a Plugin</h2>
|
|
|
72 |
|
|
|
73 |
<p>Loading a plugin file is quite simple using the following function:</p>
|
|
|
74 |
|
|
|
75 |
<code>$this->load->plugin('<var>name</var>');</code>
|
|
|
76 |
|
|
|
77 |
<p>Where <var>name</var> is the file name of the plugin, without the .php file extension or the "plugin" part.</p>
|
|
|
78 |
|
|
|
79 |
<p>For example, to load the <dfn>Captcha</dfn> plugin, which is named <var>captcha_pi.php</var>, you will do this:</p>
|
|
|
80 |
|
|
|
81 |
<code>$this->load->plugin('<var>captcha</var>');</code>
|
|
|
82 |
|
|
|
83 |
|
|
|
84 |
|
|
|
85 |
<p>A plugin can be loaded anywhere within your <a href="../general/controllers.html">controller</a> functions (or even within your <a href="../general/views.html">View files</a>, although that's not a good practice),
|
|
|
86 |
as long as you load it before you use it. You can load your plugins in your controller constructor so that they become available
|
|
|
87 |
automatically in any function, or you can load a plugin in a specific function that needs it.</p>
|
|
|
88 |
|
|
|
89 |
<p class="important">Note: The Plugin loading function above does not return a value, so don't try to assign it to a variable. Just use it as shown.</p>
|
|
|
90 |
|
|
|
91 |
|
|
|
92 |
<h2>Loading Multiple Plugins</h2>
|
|
|
93 |
|
|
|
94 |
<p>If you need to load more than one plugin you can specify them in an array, like this:</p>
|
|
|
95 |
|
|
|
96 |
<code>$this->load->plugin( <samp>array(</samp>'<var>plugin1</var>', '<var>plugin2</var>', '<var>plugin3</var>'<samp>)</samp> );</code>
|
|
|
97 |
|
|
|
98 |
<h2>Auto-loading Plugins</h2>
|
|
|
99 |
|
|
|
100 |
<p>If you find that you need a particular plugin globally throughout your application, you can tell CodeIgniter to auto-load it
|
|
|
101 |
during system initialization. This is done by opening the <var>application/config/autoload.php</var> file and adding the plugin to the autoload array.</p>
|
|
|
102 |
|
|
|
103 |
|
|
|
104 |
<h2>Using a Plugin</h2>
|
|
|
105 |
|
|
|
106 |
<p>Once you've loaded the Plugin, you'll call it the way you would a standard PHP function.</p>
|
|
|
107 |
|
|
|
108 |
|
|
|
109 |
|
|
|
110 |
|
|
|
111 |
</div>
|
|
|
112 |
<!-- END CONTENT -->
|
|
|
113 |
|
|
|
114 |
|
|
|
115 |
<div id="footer">
|
|
|
116 |
<p>
|
|
|
117 |
Previous Topic: <a href="helpers.html">Helpers</a>
|
|
|
118 |
·
|
|
|
119 |
<a href="#top">Top of Page</a> ·
|
|
|
120 |
<a href="../index.html">User Guide Home</a> ·
|
|
|
121 |
Next Topic: <a href="libraries.html">Using Libraries</a>
|
|
|
122 |
</p>
|
|
|
123 |
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2008 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
|
|
|
124 |
</div>
|
|
|
125 |
|
|
|
126 |
</body>
|
|
|
127 |
</html>
|