Manual:Hooks
 Extensions: |
Development | Tag extensions | Parser functions | Hooks | Special pages | Skins | Magic words | API | Content models |
Hooks allow custom code to be executed when some defined event (such as saving a page or a user logging in) occurs.
For example, the following code snippet will trigger a call to the function MyExtensionHooks::pageContentSaveComplete whenever the PageContentSaveComplete hook runs, passing it function arguments specific to PageContentSaveComplete.
Hooks can be registered by mapping the name of the hook to the callback in the extension's extension.json file:
"Hooks": { "PageContentSaveComplete": [ "MyExtensionHooks::onPageContentSaveComplete" ] }
MediaWiki provides many hooks like this to extend the functionality of the MediaWiki software. Assigning a function (known as an event handler) to a hook will cause that function to be called at the appropriate point in the main MediaWiki code, to perform whatever additional task(s) the developer thinks would be useful at that point. Each hook can have multiple handlers assigned to it, in which case it will call the functions in the order that they are assigned, with any modifications made by one function passed on to subsequent functions in the chain.
Assign functions to hooks at the end of LocalSettings.php or in your own extension file at the file scope (not in a $wgExtensionFunctions function or the ParserFirstCallInit hook). For extensions, if the hook function's behavior is conditioned on a setting in LocalSettings.php, the hook should be assigned and the function should terminate early if the condition was not met.
You can also create new hooks in your own extension; if you do so, add them to the Extension hook registry.
Background[edit]
A hook is triggered by a call to the function Hooks::run (described in file hooks.txt, and defined in GlobalFunctions.php. The first argument to Hooks::run is the name of the hook, the second is the array of arguments for that hook. It will find the event handlers to run in the array $wgHooks. It calls the PHP function call_user_func_array with arguments being the function to be called and its arguments.
See also the hook specification in core.
In this example from the doEditContent function in WikiPage.php, doEditContent calls Hooks::run to run the PageContentSaveComplete hook, passing $hookArgs as argument:
Hooks::run( 'PageContentSaveComplete', $hookArgs );
The core calls many hooks, but Extensions can also call hooks.
Writing an event handler[edit]
An event handler is a function you assign to a hook, which will be run whenever the event represented by that hook occurs. It consists of:
- a function with some optional accompanying data, or
- an object with a method and some optional accompanying data.
Register the event handler by adding it to the global $wgHooks array for a given event.
Hooks can be added from any point in the execution before the hook is called, but are most commonly added in LocalSettings.php, its included files, or, for extensions, in the file extension.json.
All the following are valid ways to define a hook function for the event EventName that is passed two parameters, showing the code that will be executed when EventName happens:
| Format | Syntax | Resulting function call. |
|---|---|---|
| Static function | $wgHooks['EventName'][] = 'MyExtensionHooks::onEventName';
|
MyExtensionHooks::onEventName( $param1, $param2 );
|
| Function, no data | $wgHooks['EventName'][] = 'someFunction';
|
someFunction( $param1, $param2 );
|
| Function with data | $wgHooks['EventName'][] = [ 'someFunction', $someData ];
|
someFunction( $someData, $param1, $param2 );
|
| Function, no data (weird syntax, but OK) |
$wgHooks['EventName'][] = [ 'someFunction' ];
|
someFunction( $param1, $param2 );
|
| inline anonymous function |
$wgHooks['EventName'][] = function( $param1, $param2 ) {
// ...function body
}
|
(the anonymous function is called with the hook's parameters) |
| Object only | $wgHooks['EventName'][] = $object;
|
$object->onEventName( $param1, $param2 );
|
| Object with method | $wgHooks['EventName'][] = [ $object, 'someMethod' ];
|
$object->someMethod( $param1, $param2 );
|
| Object with method and data | $wgHooks['EventName'][] = [ $object, 'someMethod', $someData ];
|
$object->someMethod( $someData, $param1, $param2 );
|
| Object only (weird syntax, but OK) |
$wgHooks['EventName'][] = [ $object ];
|
$object->onEventName( $param1, $param2 );
|
For extensions, the syntax is similar in the file extension.json (corresponding to the first and second case above):
{
"Hooks": {
"EventName": [
"MyExtensionHooks::onEventName",
"someFunction"
]
}
}
When an event occurs, the function (or object method) that you registered will be called, the event's parameters, along with any optional data you provided at registration. Note that when an object is the hook and you didn't specify a method, the method called is 'onEventName'. For other events this would be 'onArticleSave', 'onUserLogin', etc.
The optional data is useful if you want to use the same function or object for different purposes. For example:
$wgHooks['PageContentSaveComplete'][] = [ 'ircNotify', 'TimStarling' ];
$wgHooks['PageContentSaveComplete'][] = [ 'ircNotify', 'brion' ];
This code would result in ircNotify being run twice when a page is saved: once for 'TimStarling', and once for 'brion'.
Event handlers can return one of three possible values:
- no return value (or null): the hook handler has operated successfully. (Before MediaWiki 1.23, returning true was required.)
- "some string": an error occurred; processing should stop and the error should be shown to the user
- false: the hook handler has done all the work necessary, or replaced normal handling. This will prevent further handlers from being run, and in some cases tells the calling function to skip normal processing.
Returning false makes less sense for events where the action is complete, and will normally be ignored by the caller.
Documentation[edit]
Currently, hooks in MediaWiki core have to be documented both in docs/hooks.txt (in the source code repository) and here on MediaWiki.org. In some cases, one of these steps may not yet have been completed, so if a hook appears undocumented, check both.
To document a hook on-wiki, use {{MediaWikiHook}}.
Available hooks[edit]
For a complete list of hooks, use the category, which should be kept more up to date.
