wikimedia/mediawiki-core

View on GitHub
includes/Hook/TitleIsMovableHook.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

namespace MediaWiki\Hook;

use MediaWiki\Title\Title;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "TitleIsMovable" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface TitleIsMovableHook {
    /**
     * This hook is called when determining if it is possible to move a page. Note
     * that this hook is not called for interwiki pages or pages in immovable
     * namespaces: for these, isMovable() always returns false.
     *
     * @since 1.35
     *
     * @param Title $title Title object that is being checked
     * @param bool &$result Whether MediaWiki currently thinks this page is movable.
     *   Hooks may change this value to override the return value of
     *   Title::isMovable().
     * @return bool|void True or no return value to continue or false to abort
     */
    public function onTitleIsMovable( $title, &$result );
}