includes/skins/Hook/SkinTemplateNavigation__UniversalHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 // phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
   6 use SkinTemplate;
   7
   8 /**
   9  * This is a hook handler interface, see docs/Hooks.md.
  10  * Use the hook name "SkinTemplateNavigation::Universal" to register handlers implementing this interface.
  11  *
  12  * @stable to implement
  13  * @ingroup Hooks
  14  */
  15 interface SkinTemplateNavigation__UniversalHook {
  16         /**
  17          * This hook is called on both content and special pages
  18          * after variants have been added.
  19          *
  20          * @since 1.35
  21          *
  22          * @param SkinTemplate $sktemplate
  23          * @param array &$links Structured navigation links. This is used to alter the navigation for
  24          *   skins which use buildNavigationUrls such as Vector.
  25          * @return void This hook must not abort, it must return no value
  26          */
  27         public function onSkinTemplateNavigation__Universal( $sktemplate, &$links ): void;
  28 }