includes/export/Hook/XmlDumpWriterOpenPageHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 use MediaWiki\Title\Title;
   6 use stdClass;
   7 use XmlDumpWriter;
   8
   9 /**
  10  * This is a hook handler interface, see docs/Hooks.md.
  11  * Use the hook name "XmlDumpWriterOpenPage" to register handlers implementing this interface.
  12  *
  13  * @stable to implement
  14  * @ingroup Hooks
  15  */
  16 interface XmlDumpWriterOpenPageHook {
  17         /**
  18          * This hook is called at the end of XmlDumpWriter::openPage, to allow
  19          * extra metadata to be added.
  20          *
  21          * @since 1.35
  22          *
  23          * @param XmlDumpWriter $obj
  24          * @param string &$out Output string
  25          * @param stdClass $row Database row for the page
  26          * @param Title $title Title of the page
  27          * @return bool|void True or no return value to continue or false to abort
  28          */
  29         public function onXmlDumpWriterOpenPage( $obj, &$out, $row, $title );
  30 }