wikimedia/mediawiki-core

View on GitHub
includes/user/Hook/UserIsBlockedGloballyHook.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

namespace MediaWiki\User\Hook;

use MediaWiki\User\User;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "UserIsBlockedGlobally" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 * @deprecated since 1.40. Use GetUserBlockHook instead.
 */
interface UserIsBlockedGloballyHook {
    /**
     * Use this hook to establish that a user is blocked on all wikis.
     *
     * @since 1.35
     *
     * @param User $user
     * @param string $ip User's IP address
     * @param bool &$blocked Whether the user is blocked, to be modified by the hook
     * @param null &$block The Block object, to be modified by the hook
     * @return bool|void True or no return value to continue or false to abort
     */
    public function onUserIsBlockedGlobally( $user, $ip, &$blocked, &$block );
}