{"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
    \n\n\t\t
    \n\n\t\t
    \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
    php<\/div>\n\n\t\t\n\t\t
    \n\n\t<\/div>\n\t\n\t
    \n\t\t
    1. $wgExtensionFunctions<\/span>[<\/span>]<\/span> =<\/span> 'registerSampleTag'<\/span>;<\/span><\/div><\/li>\n
    2. $wgExtensionCredits<\/span>[<\/span>'parserhook'<\/span>]<\/span>[<\/span>]<\/span> =<\/span> array<\/span>(<\/span><\/div><\/li>\n
    3.     'name'<\/span> =><\/span> 'SampleTag'<\/span>,<\/span><\/div><\/li>\n
    4.     'author'<\/span> =><\/span> 'Ozh'<\/span>,<\/span><\/div><\/li>\n
    5.     'url'<\/span> =><\/span> 'http:\/\/planetozh.com\/'<\/span>,<\/span><\/div><\/li>\n
    6. )<\/span>;<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n<\/li>\n
    7. Tell the wiki that this function will be triggered by tag <ozh><\/strong>\n
      \n\n\t\t
      \n\n\t\t
      \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
      php<\/div>\n\n\t\t\n\t\t
      \n\n\t<\/div>\n\t\n\t
      \n\t\t
      1. function<\/span> registerSampleTag(<\/span>)<\/span> {<\/span><\/div><\/li>\n
      2.     global<\/span> $wgParser<\/span>;<\/span><\/div><\/li>\n
      3.     $wgParser<\/span>-><\/span>setHook<\/span>(<\/span>'ozh'<\/span>,<\/span> 'printSampleTag'<\/span>)<\/span>;<\/span><\/div><\/li>\n
      4. }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n<\/li>\n
      5. Define your special function that will take care of text enclosed in your new tag\n
        \n\n\t\t
        \n\n\t\t
        \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
        php<\/div>\n\n\t\t\n\t\t
        \n\n\t<\/div>\n\t\n\t
        \n\t\t
        1. function<\/span> printSampleTag(<\/span>$input<\/span>,<\/span>$params<\/span>)<\/span> {<\/span><\/div><\/li>\n
        2.     foreach<\/span> (<\/span>$params<\/span> as<\/span> $key<\/span>=><\/span>$value<\/span>)<\/span> {<\/span><\/div><\/li>\n
        3.         $args<\/span> .=<\/span> "<li>$key<\/span> = *$value<\/span>*<\/li>\\n<\/span>"<\/span>;<\/span><\/div><\/li>\n
        4.     }<\/span><\/div><\/li>\n
        5.     return<\/span>(<\/span>'Text : '<\/span>.<\/span>$input<\/span>.<\/span>'<br\/>Arguments :<ul>'<\/span>.<\/span>$args<\/span>.<\/span>'<\/ul>'<\/span>)<\/span>;<\/span><\/div><\/li>\n
        6. }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\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

          \n\n\t\t
          \n\n\t\t
          \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
          php<\/div>\n\n\t\t\n\t\t
          \n\n\t<\/div>\n\t\n\t
          \n\t\t
          1. include<\/span>(<\/span>"extensions\/sampleExtension.php"<\/span>)<\/span>;<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

            That's it. Now, whenever your write something like <\/p>\n

            \n\n\t\t
            \n\n\t\t
            \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
            HTML<\/div>\n\n\t\t\n\t\t
            \n\n\t<\/div>\n\t\n\t
            \n\t\t
            1. <ozh stuff=<\/span>1<\/span> thing=<\/span>"someparam"<\/span>><\/span>some text<\/<\/span>ozh><\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

              it will output <\/p>\n

              \n\n\t\t
              \n\n\t\t
              \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
              code<\/div>\n\n\t\t\n\t\t
              \n\n\t<\/div>\n\t\n\t
              \n\t\t
              1. Text : some text<\/div><\/li>\n
              2. Arguments :<\/div><\/li>\n
              3.     stuff = 1<\/div><\/li>\n
              4.     thing = someparam<\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\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

                \n\n\t\t
                \n\n\t\t
                \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
                php<\/div>\n\n\t\t\n\t\t
                \n\n\t<\/div>\n\t\n\t
                \n\t\t
                1. \/\/ Step 1 : add a new function to register<\/span><\/div><\/li>\n
                2. $wgExtensionFunctions<\/span>[<\/span>]<\/span> =<\/span> 'registerSampleFunction'<\/span>;<\/span><\/div><\/li>\n
                3. $wgExtensionCredits<\/span>[<\/span>'parserhook'<\/span>]<\/span>[<\/span>]<\/span> =<\/span> array<\/span>(<\/span><\/div><\/li>\n
                4.     'name'<\/span> =><\/span> 'SampleFunction'<\/span>,<\/span><\/div><\/li>\n
                5.     'author'<\/span> =><\/span> 'Ozh'<\/span>,<\/span><\/div><\/li>\n
                6.     'url'<\/span> =><\/span> 'http:\/\/planetozh.com\/'<\/span>,<\/span><\/div><\/li>\n
                7. )<\/span>;<\/span><\/div><\/li>\n
                8.  <\/div><\/li>\n
                9. \/\/ Step 2 : tell the Wiki that this function will be<\/span><\/div><\/li>\n
                10. \/\/ triggered by function tag {{ozh}}<\/span><\/div><\/li>\n
                11. function<\/span> registerSampleFunction(<\/span>)<\/span> {<\/span><\/div><\/li>\n
                12.     global<\/span> $wgParser<\/span>;<\/span><\/div><\/li>\n
                13.     $wgParser<\/span>-><\/span>setFunctionHook<\/span>(<\/span>'ozh'<\/span>,<\/span> 'printSampleFunction'<\/span>)<\/span>;<\/span><\/div><\/li>\n
                14. }<\/span><\/div><\/li>\n
                15.  <\/div><\/li>\n
                16. \/\/ Step 3 : now define our function<\/span><\/div><\/li>\n
                17. function<\/span> printSampleFunction(<\/span>&<\/span>$parser<\/span>,<\/span> $arg1<\/span>,<\/span> $arg2<\/span>,<\/span> $arg3<\/span>)<\/span> {<\/span><\/div><\/li>\n
                18.     return<\/span>(<\/span>"is $arg1<\/span> years old, plays $arg2<\/span> and writes poor $arg3<\/span>"<\/span>)<\/span>;<\/span><\/div><\/li>\n
                19. }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\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

                  \n\n\t\t
                  \n\n\t\t
                  \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
                  code<\/div>\n\n\t\t\n\t\t
                  \n\n\t<\/div>\n\t\n\t
                  \n\t\t
                  1. svn export --username joe --password 123456 --force http:\/\/svn.project.com\/ \/home\/ozh\/project<\/div><\/li>\n
                  2. find \/home\/ozh\/project -name '*.*' | xargs wc -l | grep total | sed -e 's\/ total\/\/' > \/home\/ozh\/project\/line.count<\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\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}]}}