f5aaf75ad1
Add hook interfaces which were generated by a script which parses
hooks.txt and identifies caller namespaces and directories.
Hook interfaces are mostly placed in a Hook/ subdirectory
relative to the caller location. When there are callers in multiple
directories, a "primary" caller was manually selected. The exceptions to
this are:
* The source root, maintenance and tests, which use includes/Hook. Test
hooks need to be autoloadable in a non-test request so that
implementing test interfaces in a generic handler will not fail.
* resources uses includes/resourceloader/Hook
* The following third-level subdirectories had their hooks placed in
the parent ../Hook:
* includes/filerepo/file
* includes/search/searchwidgets
* includes/specials/forms
* includes/specials/helpers
* includes/specials/pagers
Parameters marked as legacy references in hooks.txt are passed
by value in the interfaces.
Bug: T240307
Change-Id: I6efe2e7dd1f0c6a3d0f4d100a4c34e41f8428720
24 lines
758 B
PHP
24 lines
758 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Hook;
|
|
|
|
/**
|
|
* @stable for implementation
|
|
* @ingroup Hooks
|
|
*/
|
|
interface MakeGlobalVariablesScriptHook {
|
|
/**
|
|
* Called at end of OutputPage::getJSVars.
|
|
* Ideally, this hook should only be used to add variables that depend on
|
|
* the current page/request; static configuration should be added through
|
|
* ResourceLoaderGetConfigVars instead.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param ?mixed &$vars variable (or multiple variables) to be added into the output of
|
|
* Skin::makeVariablesScript
|
|
* @param ?mixed $out The OutputPage which called the hook, can be used to get the real title.
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onMakeGlobalVariablesScript( &$vars, $out );
|
|
}
|