MediaWiki master
MediaWiki\Hook\LogEventsListShowLogExtractHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onLogEventsListShowLogExtract (&$s, $types, $page, $user, $param)
 This hook is called before the string is added to OutputPage.

Detailed Description

This is a hook handler interface, see docs/

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

Stability: stable
to implement

Definition at line 12 of file LogEventsListShowLogExtractHook.php.

Member Function Documentation

◆ onLogEventsListShowLogExtract()

MediaWiki\Hook\LogEventsListShowLogExtractHook::onLogEventsListShowLogExtract ( & $s,
$param )

This hook is called before the string is added to OutputPage.

string&$sHTML to show for the log extract
string | array$typesLog types to show
string | null$pagePage title to show log entries for
string$userUser who made the log entries
array$paramAssociative array with the following additional options:
  • lim (integer): Limit of items to show, default is 50
  • conds (array): Extra conditions for the query (e.g. "log_action != 'revision'")
  • showIfEmpty (boolean): Set to false if you don't want any output in case the loglist is empty if set to true (default), "No matching items in log" is displayed if loglist is empty
  • msgKey (array): If you want a nice box with a message, set this to the key of the message. First element is the message key, additional optional elements are parameters for the key that are processed with wfMessage()->params()->parseAsBlock()
  • offset: Set to overwrite offset parameter in $wgRequest set to '' to unset offset
  • wrap (string): Wrap the message in html (usually something like "<div ...>$1</div>")
  • flags (integer): Display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
bool|void True or no return value to continue, or false to prevent the string from being added to the OutputPage

Implemented in MediaWiki\HookContainer\HookRunner.

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