Manual:Hooks: Difference between revisions

	Hooks::run( 'PageContentSaveComplete', $hook_args );

The Special:MyLanguage/core calls many hooks, but Special:MyLanguage/extensions can also call hooks.

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 or its included files. 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:

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:

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.

The last result would be for cases where the hook function replaces the main functionality. For example, if you wanted to authenticate users to a custom system (LDAP, another PHP program, whatever), you could do:

Returning false makes less sense for events where the action is complete, and will normally be ignored by the caller.

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 }}.

This page contains a list of hooks that are made available by the MediaWiki software, and is known to be complete to version 1.8.2. There is a lot of detail missing for the more recent hooks in particular, as their purpose/usage has not yet been documented by the developers. If you have any further information on any of these then please add it in the appropriate place.

In the tables, the first column gives the MediaWiki version that the hook was introduced in; use the link in the second column to find out more information about the hook and how to use it.

Some of these hooks can be grouped into multiple functions.

Sections: Article Management - Edit Page - Page Rendering - User Interface - Special Pages - User Management - Logging - Skinning Templates - API - Import/Export - Miscellaneous

To see hooks grouped by version go to the table above and click the arrow symbol in the version table header.

• Special:MyLanguage/Manual:$wgHooks
• Category:Hook extensions
• Special:MyLanguage/Manual:Tag extensions
• Special:MyLanguage/Manual:Parser functions
• hooks.txt
• Some Examples

[[Category:HooksTemplate:Translation]] [[Category:Customization techniquesTemplate:Translation|Hooks]] [[Category:MediaWiki hooksTemplate:Translation| ]]