wiki.techinc.nl/includes/Hook/TitleIsAlwaysKnownHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

28 lines
863 B
PHP

<?php
namespace MediaWiki\Hook;
use Title;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "TitleIsAlwaysKnown" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface TitleIsAlwaysKnownHook {
/**
* This hook is called when determining if a page exists. Use this hook to
* override default behavior for determining if a page exists. If $isKnown is
* kept as null, regular checks happen. If it's a boolean, this value is returned
* by the isKnown method.
*
* @since 1.35
*
* @param Title $title Title object that is being checked
* @param bool|null &$isKnown Whether MediaWiki currently thinks this page is known
* @return bool|void True or no return value to continue or false to abort
*/
public function onTitleIsAlwaysKnown( $title, &$isKnown );
}