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
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>C.58. $world->loadplugin</title><link rel="stylesheet" type="text/css" href="docbook.css"/><link rel="stylesheet" type="text/css" href="kildclient.css"/><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/><link rel="prev" href="func_world_listtrigger.xhtml" title="C.57. $world->listtrigger"/><link rel="next" href="func_world_logfile.xhtml" title="C.59. $world->logfile"/></head><body><header><div class="navheader"><table style="width: 100%; "><tr><th style="text-align: center; " colspan="3">C.58.
<code class="function">$world->loadplugin</code>
</th></tr><tr><td style="width: 20%; text-align: left; "><a accesskey="p" href="func_world_listtrigger.xhtml">Prev</a> </td><th style="width: 60%; text-align: center; ">Appendix C. $world Reference</th><td style="width: 20%; text-align: right; "> <a accesskey="n" href="func_world_logfile.xhtml">Next</a></td></tr></table><hr/></div></header><section class="sect1" id="func_world_loadplugin"><div class="titlepage"><div><div><h2 class="title" style="clear: both">C.58.
<code class="function">$world->loadplugin</code>
</h2></div></div></div><div class="abstract"><div class="abstract-title">Abstract</div><p>$world->loadplugin function: LOADs a PLUGIN</p></div><div class="funcsynopsis"><table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"><tr><td><code class="funcdef">$success = $world->loadplugin(</code></td><td>
<code>name</code>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"><tr><td><code class="funcdef">$success = $world->loadplugin(</code></td><td>
<code>file</code>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Loads a plugin. You can either pass a full path for the file
that defines the plugin, or just its name. If you provide only the
name, a file with that name (and the extesion <code class="filename">.pl</code>, if the extension is not already
provided) will be looked for in the directories specified by the
<code class="varname">@PLUGINDIRS</code> array. By default, this array contain
two directories: one where KildClient stores some of its files
(generally <code class="filename">/usr/local/share/kildclient/plugins</code>) and
one in the user's home directory (<code class="filename">~/.kildclient/plugins</code>), but feel free to
add more directories to search plugins for.</p><p>This function returns true if the plugin was successfully
loaded, and false otherwise (including the case in which the plugin
was already loaded). See also <a class="xref" href="func_world_requireplugin.xhtml" title="C.74. $world->requireplugin">
<code class="function">$world->requireplugin</code>
</a> for a way to load a plugin
unless it is already loaded.</p></section><footer><div class="navfooter"><hr/><table style="width: 100%; "><tr><td style="width: 40%; text-align: left; "><a accesskey="p" href="func_world_listtrigger.xhtml">Prev</a> </td><td style="width: 20%; text-align: center; "><a accesskey="u" href="apc.xhtml">Up</a></td><td style="width: 40%; text-align: right; "> <a accesskey="n" href="func_world_logfile.xhtml">Next</a></td></tr><tr><td style="width: 40%; text-align: left; vertical-align: top; ">C.57.
<code class="function">$world->listtrigger</code>
</td><td style="width: 20%; text-align: center; "><a accesskey="h" href="index.xhtml">Home</a></td><td style="width: 40%; text-align: right; vertical-align: top; "> C.59.
<code class="function">$world->logfile</code>
</td></tr></table></div></footer></body></html>
|