MediaWiki\Hook\XmlDumpWriterWriteRevisionHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\XmlDumpWriterWriteRevisionHook:

Public Member Functions
	onXmlDumpWriterWriteRevision ( $obj, &$out, $row, $text, $rev)
	This hook is called at the end of a revision in an XML dump, to add extra metadata.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 16 of file XmlDumpWriterWriteRevisionHook.php.

Member Function Documentation

onXmlDumpWriterWriteRevision()

MediaWiki\Hook\XmlDumpWriterWriteRevisionHook::onXmlDumpWriterWriteRevision	(		$obj,
		&	$out,
			$row,
			$text,
			$rev )

This hook is called at the end of a revision in an XML dump, to add extra metadata.

Since

1.35

Parameters

XmlDumpWriter	$obj
string	&$out	Text being output
stdClass	$row	Database row for the revision being dumped. DEPRECATED, use $rev instead.
string	$text	Revision text to be dumped. DEPRECATED, use $rev instead.
RevisionRecord	$rev	RevisionRecord that is being dumped to XML

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/export/Hook/XmlDumpWriterWriteRevisionHook.php