wiki.techinc.nl/includes/Hook/FormatAutocommentsHook.php
daniel e6e0ad2472 Replace "@stable for implementation" with "@stable to implement"
For compliance with the new version of the table interface policy
(T255803).

This patch was created by an automated search & replace operation
on the includes/ directory.

Bug: T257789
Change-Id: I17e5e92e24c708ffc846945a136347670a3a20c7
2020-07-13 11:05:49 +02:00

32 lines
1.1 KiB
PHP

<?php
namespace MediaWiki\Hook;
use Title;
/**
* @stable to implement
* @ingroup Hooks
*/
interface FormatAutocommentsHook {
/**
* This hook is called when an autocomment is formatted by the Linker.
*
* @since 1.35
*
* @param string|null &$comment Reference to the accumulated comment.
* Initially null, when set the default code will be skipped.
* @param bool $pre True if there is text before this autocomment
* @param string $auto Extracted part of the parsed comment before the call to the hook
* @param bool $post True if there is text after this autocomment
* @param Title|null $title Optional title object used to links to sections
* @param bool $local Whether section links should refer to local page
* @param string|null $wikiId ID (as used by WikiMap) of the wiki from which the
* autocomment originated; null for the local wiki. Added in 1.26, should default
* to null in handler functions, for backwards compatibility.
* @return bool|void True or no return value to continue or false to abort
*/
public function onFormatAutocomments( &$comment, $pre, $auto, $post, $title,
$local, $wikiId
);
}