wikimedia/mediawiki-core

<?php

namespace MediaWiki\Hook;

use LocalFile;
use MediaWiki\User\User;
use WikiFilePage;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "FileDeleteComplete" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface FileDeleteCompleteHook {
    /**
     * This hook is called when a file is deleted.
     *
     * @since 1.35
     *
     * @param LocalFile $file Reference to the deleted file
     * @param string|null $oldimage In case of the deletion of an old image, the name of the old file
     * @param WikiFilePage|null $article In case all revisions of the file are deleted, a reference to
     *   the WikiFilePage associated with the file
     * @param User $user User who performed the deletion
     * @param string $reason
     * @return bool|void True or no return value to continue or false to abort
     */
    public function onFileDeleteComplete( $file, $oldimage, $article, $user,
        $reason
    );
}