Variable_hook.php

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