MediaWiki\Hook\LogLineHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\LogLineHook:

Public Member Functions
	onLogLine ( $log_type, $log_action, $title, $paramArray, &$comment, &$revert, $time)
	Use this hook to process a single log entry on Special:Log.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file LogLineHook.php.

Member Function Documentation

onLogLine()

MediaWiki\Hook\LogLineHook::onLogLine	(		$log_type,
			$log_action,
			$title,
			$paramArray,
		&	$comment,
		&	$revert,
			$time
	)

Use this hook to process a single log entry on Special:Log.

Since

1.35

Parameters

string	$log_type	Type of log entry (e.g. 'move'). Corresponds to logging.log_type database field.
string	$log_action	Type of log action (e.g. 'delete', 'block', 'create2'). Corresponds to logging.log_action database field.
Title	$title	Title object that corresponds to logging.log_namespace and logging.log_title database fields
array	$paramArray	Parameters that correspond to logging.log_params field. Note that only $paramArray[0] appears to contain anything.
string	&$comment	Logging.log_comment database field, which is displayed in the UI
string	&$revert	String that is displayed in the UI, similar to $comment
string	$time	Timestamp of the log entry (added in 1.12)

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/logging/Hook/LogLineHook.php