GetHumanTimestampHook.php
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

GetHumanTimestampHook.php
View Options

	<?php

	namespace MediaWiki\Language\Hook;

	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 "GetHumanTimestamp" to register handlers implementing this interface.
	*
	* @stable to implement
	* @ingroup Hooks
	*/
	interface GetHumanTimestampHook {
	/**
	* Use this hook to preemptively override the human-readable timestamp
	* generated by Language::getHumanTimestamp().
	*
	* @since 1.35
	*
	* @param string &$output Output timestamp
	* @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 onGetHumanTimestamp( &$output, $timestamp, $relativeTo, $user,
	$lang
	);
	}

	/** @deprecated class alias since 1.45 */
	class_alias( GetHumanTimestampHook::class, 'MediaWiki\\Hook\\GetHumanTimestampHook' );