HelloWorldPlugin

A simple example plugin.

Hello,: WikiUser?!

From the source of this page:

<?plugin HelloWorld salutation="Hello," name="WikiUser" ?>

PhpWiki's plugin architecture allows you to add custom page elements to your wiki. All you have to do is extend (subclass) the WikiPlugin class and create your output via the run() method, dependend on the Wiki- or Request arguments,

/**
* A simple demonstration WikiPlugin.
*
* Usage:
* <?plugin HelloWorld?&gt;
* <?plugin HelloWorld
*          salutation="Greetings, "
*          name=Wikimeister
* ? >
* <?plugin HelloWorld salutation=Hi ? >
* <?plugin HelloWorld name=WabiSabi ? >
*/

// Constants are defined before the class.
if (!defined('THE_END'))
    
define('THE_END', "!");

class
WikiPlugin_HelloWorld
extends WikiPlugin
{
    
// Five required functions in a WikiPlugin.

    
function getName () {
        return
_("HelloWorld");
    }

    function
getDescription () {
        return
_("Simple Sample Plugin");

    }

    function
getVersion() {
        return
preg_replace("/[Revision: $]/", '',
                            
"\$Revision: 1.5 $");
    }

    
// Establish default values for each of this plugin's arguments.
    
function getDefaultArguments() {
        return array(
'salutation' => "Hello,",
                     
'name'       => "World");
    }

    function
run($dbi, $argstr, $request) {
        
extract($this->getArgs($argstr, $request));

        
// Any text that is returned will not be further transformed,
        // so use html where necessary.
        
$html = HTML::tt(fmt('%s: %s', $salutation, WikiLink($name, 'auto')),
                         
THE_END);
        return
$html;
    }
};

PhpWikiDocumentation WikiPlugin

Last edited on Tuesday 25 October 2005 12:48:12

Edit | PageHistory | Diff  | PageInfo
Datenschutzerklärung & Impressum