wikimedia/mediawiki-core

View on GitHub
includes/Hook/GetMagicVariableIDsHook.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

namespace MediaWiki\Hook;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "GetMagicVariableIDs" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface GetMagicVariableIDsHook {
    /**
     * Use this hook to modify the list of magic variables.
     * Magic variables are localized with the magic word system,
     * and this hook is called by MagicWordFactory.
     *
     * @since 1.35
     *
     * @param string[] &$variableIDs array of magic word identifiers
     * @return bool|void True or no return value to continue or false to abort
     */
    public function onGetMagicVariableIDs( &$variableIDs );
}