wiki.techinc.nl/includes/Hook/GetRelativeTimestampHook.php
James D. Forrester bc662aec9b Move Language and friends into Language namespace
Bug: T353458
Change-Id: Id3202c0c4f4a2043bf97b7caee081acab684155c
2024-08-10 13:36:30 +02:00

35 lines
1.1 KiB
PHP

<?php
namespace MediaWiki\Hook;
use DateInterval;
use MediaWiki\Language\Language;
use MediaWiki\User\User;
use MediaWiki\Utils\MWTimestamp;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "GetRelativeTimestamp" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface GetRelativeTimestampHook {
/**
* Use this hook to pre-emptively override the relative timestamp generated
* by MWTimestamp::getRelativeTimestamp().
*
* @since 1.35
*
* @param string &$output String for the output timestamp
* @param DateInterval &$diff Difference between the timestamps
* @param MWTimestamp $timestamp Current (user-adjusted) timestamp
* @param MWTimestamp $relativeTo Relative (user-adjusted) timestamp
* @param User $user User whose preferences are being used to make timestamp
* @param Language $lang Language that will be used to render the timestamp
* @return bool|void True or no return value to continue, or false to use the custom output
*/
public function onGetRelativeTimestamp( &$output, &$diff, $timestamp,
$relativeTo, $user, $lang
);
}