MediaWiki\Hook\GetRelativeTimestampHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\Hook\GetRelativeTimestampHook:

Public Member Functions
	onGetRelativeTimestamp (&$output, &$diff, $timestamp, $relativeTo, $user, $lang)
	Use this hook to pre-emptively override the relative timestamp generated by MWTimestamp::getRelativeTimestamp().

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "GetRelativeTimestamp" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 17 of file GetRelativeTimestampHook.php.

Member Function Documentation

onGetRelativeTimestamp()

MediaWiki\Hook\GetRelativeTimestampHook::onGetRelativeTimestamp	(	&	$output,
		&	$diff,
			$timestamp,
			$relativeTo,
			$user,
			$lang )

Use this hook to pre-emptively override the relative timestamp generated by MWTimestamp::getRelativeTimestamp().

Since

1.35

Parameters

string	&$output	String for the output timestamp
DateInterval	&$diff	Difference between the timestamps
MWTimestamp	$timestamp	Current (user-adjusted) timestamp
MWTimestamp	$relativeTo	Relative (user-adjusted) timestamp
User	$user	User whose preferences are being used to make timestamp
Language	$lang	Language that will be used to render the timestamp

Returns

bool|void True or no return value to continue, or false to use the custom output

Implemented in MediaWiki\HookContainer\HookRunner.

---

The documentation for this interface was generated from the following file:

• includes/Hook/GetRelativeTimestampHook.php