Variable_hook.php

   1 <?php
   2 if ( !defined( 'MEDIAWIKI' ) ) die();
   3 /**
   4  * An example parser hook that defines a new variable, {{EXAMPLE}}
   5  *
   6  * @file
   7  * @ingroup Extensions
   8  *
   9  * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
  10  * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason
  11  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
  12  */
  13
  14 $wgExtensionCredits['variable'][] = array(
  15         'path' => __FILE__,
  16         'name' => 'Parser hook',
  17         'description' => 'a sample variable hook',
  18         'author' => 'Ævar Arnfjörð Bjarmason'
  19 );
  20
  21 $wgHooks['MagicWordwgVariableIDs'][] = 'wfVariableHookVariables';
  22 $wgHooks['ParserGetVariableValueSwitch'][] = 'wfVariableHookSwitch';
  23
  24 $dir = dirname(__FILE__) . '/';
  25 $wgExtensionMessagesFiles['Variable_hookMagic'] = $dir . 'Variable_hook.i18n.magic.php';
  26
  27 function wfVariableHookVariables( &$wgVariableIDs ) {
  28         $wgVariableIDs[] = 'example';
  29
  30         return true;
  31 }
  32
  33 function wfVariableHookSwitch( &$parser, &$varCache, &$index, &$ret ) {
  34         if ( $index === 'example' ) {
  35                 $ret = $varCache[$index] = wfVariableHookRet();
  36         }
  37         return true;
  38 }
  39
  40 function wfVariableHookRet() {
  41         return 'example';
  42 }