wiki.techinc.nl/includes/Hook/PreferencesGetLayoutHook.php
suecarmol 0b2dca01b9 HookRunner - Change PreferencesGetLayoutHook params
Changed the PreferencesGetLayoutHook parameters so that it no longer passes a Skin variable. Now, the hook will pass an additional string variable with the skin name and an associative array with extra skin properties the hook might need.

Bug: T322781

Change-Id: I0c4e76b528d0196ae6929fd8ed71abc6c860dfc4
Depends-On: I200aec586dbe8613e9a9c762db8d9bcbdc69a35b
2022-11-21 18:51:46 -06:00

28 lines
1,000 B
PHP

<?php
namespace MediaWiki\Hook;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "PreferencesGetLayout" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface PreferencesGetLayoutHook {
/**
* Use the hook to check if the preferences will have a mobile or desktop layout.
*
* @since 1.40
* @param bool &$useMobileLayout a boolean which will indicate whether to use
* a mobile layout or not
* @param string $skinName the name of the skin being used
* @param array $skinProperties an associative array that includes skin properties.
* A skin property could be one of the following:
* - `isResponsive`: Whether a skin can be responsive.
* - `getVersion`: Get the version of the skin.
* Is an empty array by default
* @return bool|void True or no return value to continue or false to abort
*/
public function onPreferencesGetLayout( &$useMobileLayout, $skinName, $skinProperties = [] );
}