includes/title/Hook/NamespaceIsMovableHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 /**
   6  * This is a hook handler interface, see docs/Hooks.md.
   7  * Use the hook name "NamespaceIsMovable" to register handlers implementing this interface.
   8  *
   9  * @stable to implement
  10  * @ingroup Hooks
  11  */
  12 interface NamespaceIsMovableHook {
  13         /**
  14          * This hook is called when determining if it is possible to move pages in a
  15          * namespace.
  16          *
  17          * @since 1.35
  18          *
  19          * @param int $index Index of the namespace being checked
  20          * @param bool &$result Whether MediaWiki currently thinks that pages in this
  21          *   namespace are movable. Hooks may change this value to override the return
  22          *   value of NamespaceInfo::isMovable().
  23          * @return bool|void True or no return value to continue or false to abort
  24          */
  25         public function onNamespaceIsMovable( $index, &$result );
  26 }