wikimedia/mediawiki-core

View on GitHub
includes/Hook/PageMoveCompleteHook.php

Summary

Maintainability
A
50 mins
Test Coverage
<?php

namespace MediaWiki\Hook;

use MediaWiki\Linker\LinkTarget;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\User\UserIdentity;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "PageMoveComplete" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface PageMoveCompleteHook {
    /**
     * This hook is called after moving an article (title), post-commit
     *
     * @since 1.35
     *
     * @param LinkTarget $old Old title
     * @param LinkTarget $new New title
     * @param UserIdentity $user User who did the move
     * @param int $pageid Database ID of the page that's been moved
     * @param int $redirid Database ID of the created redirect
     * @param string $reason Reason for the move
     * @param RevisionRecord $revision RevisionRecord created by the move
     * @return bool|void True or no return value to continue or false stop other hook handlers,
     *     doesn't abort the move itself
     */
    public function onPageMoveComplete( $old, $new, $user, $pageid, $redirid,
        $reason, $revision
    );
}