Hooks.php

Go to the documentation of this file.

<?php
 
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\MediaWikiServices;
 
class Hooks {
 
    public static function register( $name, $callback ) {
        if ( !defined( 'MW_SERVICE_BOOTSTRAP_COMPLETE' ) ) {
            wfDeprecated( 'Registering handler for ' . $name .
                ' before MediaWiki bootstrap complete', '1.35' );
        }
        $hookContainer = MediaWikiServices::getInstance()->getHookContainer();
        $hookContainer->register( $name, $callback );
    }
 
    public static function clear( $name ) {
        wfDeprecated( __METHOD__, '1.35' );
        if ( !defined( 'MW_PHPUNIT_TEST' ) && !defined( 'MW_PARSER_TEST' ) ) {
            throw new MWException( 'Cannot reset hooks in operation.' );
        }
        $hookContainer = MediaWikiServices::getInstance()->getHookContainer();
        $hookContainer->clear( $name );
    }
 
    public static function isRegistered( $name ) {
        $hookContainer = MediaWikiServices::getInstance()->getHookContainer();
        return $hookContainer->isRegistered( $name );
    }
 
    public static function getHandlers( $name ) {
        $hookContainer = MediaWikiServices::getInstance()->getHookContainer();
        $handlers = $hookContainer->getLegacyHandlers( $name );
        $funcName = 'on' . str_replace( ':', '_',  ucfirst( $name ) );
        foreach ( $hookContainer->getHandlers( $name ) as $obj ) {
            $handlers[] = [ $obj, $funcName ];
        }
        return $handlers;
    }
 
    public static function run( $event, array $args = [], $deprecatedVersion = null ) {
        $hookContainer = MediaWikiServices::getInstance()->getHookContainer();
        $options = $deprecatedVersion ? [ 'deprecatedVersion' => $deprecatedVersion ] : [];
        return $hookContainer->run( $event, $args, $options );
    }
 
    public static function runWithoutAbort( $event, array $args = [], $deprecatedVersion = null ) {
        $hookContainer = MediaWikiServices::getInstance()->getHookContainer();
        $options = $deprecatedVersion ? [ 'deprecatedVersion' => $deprecatedVersion ] : [];
        $options[ 'abortable' ] = false;
        return $hookContainer->run( $event, $args, $options );
    }
 
    public static function runner() {
        return new HookRunner( MediaWikiServices::getInstance()->getHookContainer() );
    }
}