{"id":545,"date":"2006-05-30T23:58:30","date_gmt":"2006-05-30T21:58:30","guid":{"rendered":"http:\/\/frenchfragfactory.net\/ozh\/archives\/2006\/05\/30\/how-to-add-a-custom-function-to-mediawiki\/"},"modified":"2008-06-13T21:04:48","modified_gmt":"2008-06-13T19:04:48","slug":"how-to-add-a-custom-function-to-mediawiki","status":"publish","type":"post","link":"https:\/\/planetozh.com\/blog\/2006\/05\/how-to-add-a-custom-function-to-mediawiki\/","title":{"rendered":"How to Add a Custom Function to MediaWiki"},"content":{"rendered":"

Recently, I wanted to add some dynamic content to a Mediawiki<\/a> page : I wanted a project page to show how many lines of code the project currently had, and therefore I wanted something like <linecount><\/strong> to be converted into something special.<\/p>\n

Piece of cake ? Piece of cake. Adding custom tags or custom complex functions to your wiki is really easy, and here is how it can be done.
\n<\/p>\n

Adding a custom tag<\/h2>\n

For example, let's create the HTML tag <ozh><\/strong>. Declaring a custom HTML tags in Mediawiki is done in 3 steps :<\/p>\n

    \n
  1. Register a new function :\n
    $wgExtensionFunctions[] = 'registerSampleTag';\r\n$wgExtensionCredits['parserhook'][] = array(\r\n\t'name' => 'SampleTag',\r\n\t'author' => 'Ozh',\r\n\t'url' => 'http:\/\/planetozh.com\/',\r\n);<\/code><\/pre><\/div>\n<\/li>\n
  2. Tell the wiki that this function will be triggered by tag <ozh><\/strong>\n
    function registerSampleTag() {\r\n    global $wgParser;\r\n    $wgParser->setHook('ozh', 'printSampleTag');\r\n}<\/code><\/pre><\/div>\n<\/li>\n
  3. Define your special function that will take care of text enclosed in your new tag\n
    function printSampleTag($input,$params) {\r\n\tforeach ($params as $key=>$value) {\r\n\t\t$args .= "<li>$key = *$value*<\/li>\\n";\r\n\t}\r\n\treturn('Text : '.$input.'<br\/>Arguments :<ul>'.$args.'<\/ul>');\r\n}<\/code><\/pre><\/div>\n<\/li>\n<\/ol>\n
    Put these 3 functions in a file named for example sampleExtension.php<\/strong> in directory mediawiki\/extensions<\/strong>, then edit mediawiki\/LocalSettings.php<\/strong> and add the following at the end of the file, before the closing PHP tag ?><\/strong> :<\/p>\n
    include("extensions\/sampleExtension.php");<\/code><\/pre><\/div>\n
    That's it. Now, whenever your write something like <\/p>\n
    <ozh stuff=1 thing="someparam">some text<\/ozh><\/code><\/pre><\/div>\n
     it will output <\/p>\n
    Text : some text\r\nArguments :\r\n\tstuff = 1\r\n\tthing = someparam<\/code><\/pre><\/div>\n
    Ok, not the most useful stuff, but you get the idea :)<\/p>\n
    Adding a custom complex function<\/h2>\n
    Now, you want to create something more complex, for example you'd like a custom function adequately named ozh that would convert "{{ozh:34|Quake|PHP}}" converted into "is 34 years old, plays Quake and writes poor PHP".<\/p>\n
    Your custom function declaration goes through 3 similar steps :<\/p>\n
    \/\/ Step 1 : add a new function to register\r\n$wgExtensionFunctions[] = 'registerSampleFunction';\r\n$wgExtensionCredits['parserhook'][] = array(\r\n\t'name' => 'SampleFunction',\r\n\t'author' => 'Ozh',\r\n\t'url' => 'http:\/\/planetozh.com\/',\r\n);\r\n\r\n\/\/ Step 2 : tell the Wiki that this function will be\r\n\/\/ triggered by function tag {{ozh}}\r\nfunction registerSampleFunction() {\r\n    global $wgParser;\r\n    $wgParser->setFunctionHook('ozh', 'printSampleFunction');\r\n}\r\n\r\n\/\/ Step 3 : now define our function\r\nfunction printSampleFunction(&$parser, $arg1, $arg2, $arg3) {\r\n\treturn("is $arg1 years old, plays $arg2 and writes poor $arg3");\r\n}<\/code><\/pre><\/div>\n
    So …<\/h2>\n
    How simple was it ? <\/p>\n
    For the curious readers, adding a line count from a subversion project was done with a bash script like :<\/p>\n
    svn export --username joe --password 123456 --force http:\/\/svn.project.com\/ \/home\/ozh\/project\r\nfind \/home\/ozh\/project -name '*.*' | xargs wc -l | grep total | sed -e 's\/ total\/\/' > \/home\/ozh\/project\/line.count<\/code><\/pre><\/div>\n
    The script is run periodically via cron, and a custom tag <linecount><\/strong> simply calls a function that returns file_get_content('\/home\/ozh\/project\/line.count');<\/strong><\/p>\n","protected":false},"excerpt":{"rendered":"
    Create your own complex functions in your wiki.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[21],"tags":[5,2,10,76,171],"class_list":["post-545","post","type-post","status-publish","format-standard","hentry","category-published","tag-bash","tag-code","tag-php","tag-tips","tag-wiki"],"_links":{"self":[{"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/posts\/545","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/comments?post=545"}],"version-history":[{"count":0,"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/posts\/545\/revisions"}],"wp:attachment":[{"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/media?parent=545"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/categories?post=545"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/tags?post=545"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}