2005-08-17 19:48:24 +00:00
hooks.txt
2004-11-27 21:43:06 +00:00
2008-07-05 11:36:55 +00:00
This document describes how event hooks work in MediaWiki; how to add hooks for
an event; and how to run hooks for an event.
2004-11-27 21:43:06 +00:00
==Glossary==
event
2008-07-05 11:36:55 +00:00
Something that happens with the wiki. For example: a user logs in. A wiki
page is saved. A wiki page is deleted. Often there are two events
associated with a single action: one before the code is run to make the
event happen, and one after. Each event has a name, preferably in
CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
'ArticleDelete'.
2004-11-27 21:43:06 +00:00
hook
2008-07-05 11:36:55 +00:00
A clump of code and data that should be run when an event happens. This can
be either a function and a chunk of data, or an object and a method.
2009-06-18 02:13:42 +00:00
2004-11-27 21:43:06 +00:00
hook function
The function part of a hook.
2009-06-18 02:13:42 +00:00
2004-11-27 21:43:06 +00:00
==Rationale==
2008-07-05 11:36:55 +00:00
Hooks allow us to decouple optionally-run code from code that is run for
everyone. It allows MediaWiki hackers, third-party developers and local
administrators to define code that will be run at certain points in the mainline
code, and to modify the data run by that mainline code. Hooks can keep mainline
code simple, and make it easier to write extensions. Hooks are a principled
alternative to local patches.
2004-11-27 21:43:06 +00:00
2008-07-05 11:36:55 +00:00
Consider, for example, two options in MediaWiki. One reverses the order of a
title before displaying the article; the other converts the title to all
uppercase letters. Currently, in MediaWiki code, we would handle this as follows
(note: not real code, here):
2004-11-27 21:43:06 +00:00
2007-06-18 15:34:04 +00:00
function showAnArticle($article) {
global $wgReverseTitle, $wgCapitalizeTitle;
if ($wgReverseTitle) {
wfReverseTitle($article);
}
if ($wgCapitalizeTitle) {
wfCapitalizeTitle($article);
}
# code to actually show the article goes here
}
2007-04-30 22:29:56 +00:00
2008-07-05 11:36:55 +00:00
An extension writer, or a local admin, will often add custom code to the
function -- with or without a global variable. For example, someone wanting
email notification when an article is shown may add:
2004-11-27 21:43:06 +00:00
function showAnArticle($article) {
2008-07-05 11:36:55 +00:00
global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
2009-06-18 02:13:42 +00:00
2008-07-05 11:36:55 +00:00
if ($wgReverseTitle) {
wfReverseTitle($article);
}
2009-06-18 02:13:42 +00:00
2008-07-05 11:36:55 +00:00
if ($wgCapitalizeTitle) {
wfCapitalizeTitle($article);
}
2004-11-27 21:43:06 +00:00
2008-07-05 11:36:55 +00:00
# code to actually show the article goes here
2009-06-18 02:13:42 +00:00
2008-07-05 11:36:55 +00:00
if ($wgNotifyArticle) {
wfNotifyArticleShow($article));
}
2009-07-21 11:48:52 +00:00
}
2004-11-27 21:43:06 +00:00
2008-07-05 11:36:55 +00:00
Using a hook-running strategy, we can avoid having all this option-specific
stuff in our mainline code. Using hooks, the function becomes:
2004-11-27 21:43:06 +00:00
2007-06-18 15:37:10 +00:00
function showAnArticle($article) {
Changed the calling protocol for function wfRunHooks() in Hooks.php.
Previously, this function used variable arguments to allow
different hooks to pass different parameters. However, var args
silently convert reference-calling to value-calling. So a call
that used to work like this:
# old
wfRunHooks('SomeEvent', $param1, &$param2, $param3);
...now works like this:
# new
wfRunHooks('SomeEvent', array($param1, &$param2, $param3));
Hook functions can now change pass-by-reference parameters correctly
(e.g. $param2 in the above example).
All calls to wfRunHooks() were changed and tested, and the change
was documented in docs/hooks.doc. This change was originally checked
in on REL1_4 branch as a bugfix, but per vibber reverted and checked
in to HEAD instead.
2005-03-13 15:29:43 +00:00
2007-06-18 15:37:10 +00:00
if (wfRunHooks('ArticleShow', array(&$article))) {
# code to actually show the article goes here
wfRunHooks('ArticleShowComplete', array(&$article));
}
2004-11-27 21:43:06 +00:00
}
2008-07-05 11:36:55 +00:00
We've cleaned up the code here by removing clumps of weird, infrequently used
code and moving them off somewhere else. It's much easier for someone working
with this code to see what's _really_ going on, and make changes or fix bugs.
2004-11-27 21:43:06 +00:00
2009-06-18 02:13:42 +00:00
In addition, we can take all the code that deals with the little-used
2008-07-05 11:36:55 +00:00
title-reversing options (say) and put it in one place. Instead of having little
title-reversing if-blocks spread all over the codebase in showAnArticle,
deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
file:
2004-11-27 21:43:06 +00:00
2007-06-18 15:37:10 +00:00
function reverseArticleTitle($article) {
# ...
}
2004-11-27 21:43:06 +00:00
2007-06-18 15:37:10 +00:00
function reverseForExport($article) {
# ...
}
2004-11-27 21:43:06 +00:00
2008-07-05 11:36:55 +00:00
The setup function for the extension just has to add its hook functions to the
appropriate events:
2004-11-27 21:43:06 +00:00
2007-06-18 15:37:10 +00:00
setupTitleReversingExtension() {
global $wgHooks;
$wgHooks['ArticleShow'][] = 'reverseArticleTitle';
$wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
$wgHooks['ArticleExport'][] = 'reverseForExport';
}
2004-11-27 21:43:06 +00:00
2008-07-05 11:36:55 +00:00
Having all this code related to the title-reversion option in one place means
that it's easier to read and understand; you don't have to do a grep-find to see
where the $wgReverseTitle variable is used, say.
2004-11-27 21:43:06 +00:00
2009-06-18 02:13:42 +00:00
If the code is well enough isolated, it can even be excluded when not used --
making for some slight savings in memory and load-up performance at runtime.
2008-07-05 11:36:55 +00:00
Admins who want to have all the reversed titles can add:
2004-11-27 21:43:06 +00:00
2007-06-18 15:37:10 +00:00
require_once('extensions/ReverseTitle.php');
2008-07-05 11:36:55 +00:00
...to their LocalSettings.php file; those of us who don't want or need it can
just leave it out.
2004-11-27 21:43:06 +00:00
2008-07-05 11:36:55 +00:00
The extensions don't even have to be shipped with MediaWiki; they could be
provided by a third-party developer or written by the admin him/herself.
2004-11-27 21:43:06 +00:00
==Writing hooks==
A hook is a chunk of code run at some particular event. It consists of:
* a function with some optional accompanying data, or
* an object with a method and some optional accompanying data.
2008-07-05 11:36:55 +00:00
Hooks are registered by adding them to the global $wgHooks array for a given
event. All the following are valid ways to define hooks:
2004-11-27 21:43:06 +00:00
2007-06-18 15:37:10 +00:00
$wgHooks['EventName'][] = 'someFunction'; # function, no data
$wgHooks['EventName'][] = array('someFunction', $someData);
$wgHooks['EventName'][] = array('someFunction'); # weird, but OK
$wgHooks['EventName'][] = $object; # object only
$wgHooks['EventName'][] = array($object, 'someMethod');
$wgHooks['EventName'][] = array($object, 'someMethod', $someData);
$wgHooks['EventName'][] = array($object); # weird but OK
2004-11-27 21:43:06 +00:00
2008-07-05 11:36:55 +00:00
When an event occurs, the function (or object method) will be called with the
optional data provided as well as event-specific parameters. The above examples
would result in the following code being executed when 'EventName' happened:
2004-11-27 21:43:06 +00:00
2007-06-18 15:37:10 +00:00
# function, no data
someFunction($param1, $param2)
# function with data
someFunction($someData, $param1, $param2)
# object only
$object->onEventName($param1, $param2)
# object with method
$object->someMethod($param1, $param2)
# object with method and data
$object->someMethod($someData, $param1, $param2)
2009-06-18 02:13:42 +00:00
2008-07-05 11:36:55 +00:00
Note that when an object is the hook, and there's no specified method, the
default method called is 'onEventName'. For different events this would be
different: 'onArticleSave', 'onUserLogin', etc.
2004-11-27 21:43:06 +00:00
2008-07-05 11:36:55 +00:00
The extra data is useful if we want to use the same function or object for
different purposes. For example:
2004-11-27 21:43:06 +00:00
2007-06-18 15:37:10 +00:00
$wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
$wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
2004-11-27 21:43:06 +00:00
2008-07-05 11:36:55 +00:00
This code would result in ircNotify being run twice when an article is saved:
once for 'TimStarling', and once for 'brion'.
2004-11-27 21:43:06 +00:00
Hooks can return three possible values:
Changed the calling protocol for function wfRunHooks() in Hooks.php.
Previously, this function used variable arguments to allow
different hooks to pass different parameters. However, var args
silently convert reference-calling to value-calling. So a call
that used to work like this:
# old
wfRunHooks('SomeEvent', $param1, &$param2, $param3);
...now works like this:
# new
wfRunHooks('SomeEvent', array($param1, &$param2, $param3));
Hook functions can now change pass-by-reference parameters correctly
(e.g. $param2 in the above example).
All calls to wfRunHooks() were changed and tested, and the change
was documented in docs/hooks.doc. This change was originally checked
in on REL1_4 branch as a bugfix, but per vibber reverted and checked
in to HEAD instead.
2005-03-13 15:29:43 +00:00
2004-11-27 21:43:06 +00:00
* true: the hook has operated successfully
2008-07-05 11:36:55 +00:00
* "some string": an error occurred; processing should stop and the error
should be shown to the user
* false: the hook has successfully done the work necessary and the calling
function should skip
2009-06-18 02:13:42 +00:00
2008-07-05 11:36:55 +00:00
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:
2004-11-27 21:43:06 +00:00
2007-06-18 15:37:10 +00:00
$wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
2009-06-18 02:13:42 +00:00
2007-06-18 15:37:10 +00:00
function ldapLogin($username, $password) {
# log user into LDAP
return false;
}
2004-11-27 21:43:06 +00:00
2008-07-05 11:36:55 +00:00
Returning false makes less sense for events where the action is complete, and
will normally be ignored.
2004-11-27 21:43:06 +00:00
2008-09-12 02:45:36 +00:00
Note that none of the examples made use of create_function() as a way to
2009-06-18 02:13:42 +00:00
attach a function to a hook. This is known to cause problems (notably with
2008-09-12 02:45:36 +00:00
Special:Version), and should be avoided when at all possible.
2004-11-27 21:43:06 +00:00
==Using hooks==
2008-07-05 11:36:55 +00:00
A calling function or method uses the wfRunHooks() function to run the hooks
related to a particular event, like so:
2004-11-27 21:43:06 +00:00
2009-06-18 02:13:42 +00:00
class Article {
2007-06-18 15:37:10 +00:00
# ...
function protect() {
global $wgUser;
if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
# protect the article
wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
}
}
2004-11-27 21:43:06 +00:00
}
2009-06-18 02:13:42 +00:00
2008-07-05 11:36:55 +00:00
wfRunHooks() returns true if the calling function should continue processing
(the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
error occurred, or one of the hooks handled the action already). Checking the
return value matters more for "before" hooks than for "complete" hooks.
2004-11-27 21:43:06 +00:00
Changed the calling protocol for function wfRunHooks() in Hooks.php.
Previously, this function used variable arguments to allow
different hooks to pass different parameters. However, var args
silently convert reference-calling to value-calling. So a call
that used to work like this:
# old
wfRunHooks('SomeEvent', $param1, &$param2, $param3);
...now works like this:
# new
wfRunHooks('SomeEvent', array($param1, &$param2, $param3));
Hook functions can now change pass-by-reference parameters correctly
(e.g. $param2 in the above example).
All calls to wfRunHooks() were changed and tested, and the change
was documented in docs/hooks.doc. This change was originally checked
in on REL1_4 branch as a bugfix, but per vibber reverted and checked
in to HEAD instead.
2005-03-13 15:29:43 +00:00
Note that hook parameters are passed in an array; this is a necessary
2008-07-05 11:36:55 +00:00
inconvenience to make it possible to pass reference values (that can be changed)
into the hook code. Also note that earlier versions of wfRunHooks took a
variable number of arguments; the array() calling protocol came about after
MediaWiki 1.4rc1.
Changed the calling protocol for function wfRunHooks() in Hooks.php.
Previously, this function used variable arguments to allow
different hooks to pass different parameters. However, var args
silently convert reference-calling to value-calling. So a call
that used to work like this:
# old
wfRunHooks('SomeEvent', $param1, &$param2, $param3);
...now works like this:
# new
wfRunHooks('SomeEvent', array($param1, &$param2, $param3));
Hook functions can now change pass-by-reference parameters correctly
(e.g. $param2 in the above example).
All calls to wfRunHooks() were changed and tested, and the change
was documented in docs/hooks.doc. This change was originally checked
in on REL1_4 branch as a bugfix, but per vibber reverted and checked
in to HEAD instead.
2005-03-13 15:29:43 +00:00
2004-11-27 23:10:05 +00:00
==Events and parameters==
2008-07-05 11:36:55 +00:00
This is a list of known events and parameters; please add to it if you're going
to add events to the MediaWiki code.
2004-11-27 23:10:05 +00:00
2011-04-05 01:18:40 +00:00
'AbortAutoAccount': Return false to cancel automated local account creation, where normally authentication against an external auth plugin would be creating a local account.
$user: the User object about to be created (read-only, incomplete)
2011-06-07 21:20:07 +00:00
&$abortMsg: out parameter: name of error message to be displayed to user
2011-04-05 01:18:40 +00:00
2008-05-23 10:34:11 +00:00
'AbortAutoblock': Return false to cancel an autoblock.
$autoblockip: The IP going to be autoblocked.
$block: The block from which the autoblock is coming.
2008-11-06 21:41:07 +00:00
'AbortDiffCache': Can be used to cancel the caching of a diff
&$diffEngine: DifferenceEngine object
2007-05-07 21:54:06 +00:00
'AbortLogin': Return false to cancel account login.
$user: the User object being authenticated against
$password: the password being submitted, not yet checked for validity
2009-09-26 00:49:32 +00:00
&$retval: a LoginForm class constant to return from authenticateUserData();
default is LoginForm::ABORTED. Note that the client may be using
2007-05-07 21:54:06 +00:00
a machine API rather than the HTML user interface.
2011-03-06 06:07:14 +00:00
&$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
2007-05-07 21:54:06 +00:00
2007-12-08 18:30:00 +00:00
'AbortMove': allows to abort moving an article (title)
$old: old title
$nt: new title
$user: user who is doing the move
$err: error message
2008-06-24 13:03:16 +00:00
$reason: the reason for the move (added in 1.13)
2007-12-08 18:30:00 +00:00
2011-04-05 01:18:40 +00:00
'AbortNewAccount': Return false to cancel explicit account creation.
2005-12-17 03:18:39 +00:00
$user: the User object about to be created (read-only, incomplete)
2011-06-07 21:20:07 +00:00
&$msg: out parameter: name of error message to display on abort
2005-12-17 03:18:39 +00:00
2011-06-13 14:55:03 +00:00
'ActionBeforeFormDisplay': before executing the HTMLForm object
$name: name of the action
&$form: HTMLForm object
$article: Article object
'ActionModifyFormFields': before creating an HTMLForm object for a page action;
allows to change the fields on the form that will be generated
$name: name of the action
&$fields: HTMLForm descriptor array
$article: Article object
2005-08-17 07:44:38 +00:00
'AddNewAccount': after a user account is created
2006-04-17 04:06:13 +00:00
$user: the User object that was created. (Parameter added in 1.7)
2008-01-29 16:18:55 +00:00
$byEmail: true when account was created "by email" (added in 1.12)
2005-08-17 07:44:38 +00:00
2010-07-03 14:33:09 +00:00
'AfterImportPage': When a page import is completed
$title: Title under which the revisions were imported
$origTitle: Title provided by the XML file
$revCount: Number of revisions in the XML file
$sRevCount: Number of sucessfully imported revisions
$pageInfo: associative array of page information
2007-08-28 21:53:50 +00:00
'AjaxAddScript': Called in output page just before the initialisation
of the javascript ajax engine. The hook is only called when ajax
is enabled ( $wgUseAjax = true; ).
2007-05-19 21:45:07 +00:00
'AlternateEdit': before checking if an user can edit a page and
before showing the edit form ( EditPage::edit() ). This is triggered
on &action=edit.
2009-07-21 11:48:52 +00:00
$EditPage: the EditPage object
2007-05-19 21:45:07 +00:00
2011-07-28 19:19:42 +00:00
'AlternateUserMailer': Called before mail is sent so that mail could
2011-08-02 19:35:01 +00:00
be logged (or something else) instead of using PEAR or PHP's mail().
Return false to skip the regular method of sending mail. Return a
string to return a php-mail-error message containing the error.
Returning true will continue with sending email in the regular way.
2011-07-28 19:19:42 +00:00
$headers: Associative array of headers for the email
$to: MailAddress object or array
$from: From address
$subject: Subject of the email
$body: Body of the message
2008-09-17 18:49:22 +00:00
'APIAfterExecute': after calling the execute() method of an API module.
Use this to extend core API modules.
&$module: Module object
2008-03-03 18:08:40 +00:00
'APIEditBeforeSave': before saving a page with api.php?action=edit,
after processing request parameters. Return false to let the request
fail, returning an error message or an <edit result="Failure"> tag
if $resultArr was filled.
$EditPage : the EditPage object
$text : the new text of the article (has yet to be saved)
2009-08-21 21:51:29 +00:00
&$resultArr : data in this array will be added to the API result
2008-03-03 18:08:40 +00:00
2008-09-07 19:04:51 +00:00
'APIGetAllowedParams': use this hook to modify a module's parameters.
&$module: Module object
&$params: Array of parameters
'APIGetParamDescription': use this hook to modify a module's parameter
descriptions.
&$module: Module object
&$desc: Array of parameter descriptions
2008-09-17 18:49:22 +00:00
'APIQueryAfterExecute': after calling the execute() method of an
action=query submodule. Use this to extend core API modules.
&$module: Module object
'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
method of an action=query submodule. Use this to extend core API modules.
&$module: Module object
&$resultPageSet: ApiPageSet object
2008-07-04 12:07:02 +00:00
'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
Every token has an action, which will be used in the intoken parameter
and in the output (actiontoken="..."), and a callback function which
should return the token, or false if the user isn't allowed to obtain
it. The prototype of the callback function is func($pageid, $title)
where $pageid is the page ID of the page the token is requested for
and $title is the associated Title object. In the hook, just add
your callback to the $tokenFunctions array and return true (returning
false makes no sense)
$tokenFunctions: array(action => callback)
'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
Every token has an action, which will be used in the rvtoken parameter
and in the output (actiontoken="..."), and a callback function which
should return the token, or false if the user isn't allowed to obtain
it. The prototype of the callback function is func($pageid, $title, $rev)
where $pageid is the page ID of the page associated to the revision the
token is requested for, $title the associated Title object and $rev the
associated Revision object. In the hook, just add your callback to the
$tokenFunctions array and return true (returning false makes no sense)
$tokenFunctions: array(action => callback)
2009-05-28 17:05:09 +00:00
'APIQueryRecentChangesTokens': use this hook to add custom tokens to
list=recentchanges.
2008-09-04 15:17:51 +00:00
Every token has an action, which will be used in the rctoken parameter
and in the output (actiontoken="..."), and a callback function which
should return the token, or false if the user isn't allowed to obtain
it. The prototype of the callback function is func($pageid, $title, $rc)
where $pageid is the page ID of the page associated to the revision the
token is requested for, $title the associated Title object and $rc the
associated RecentChange object. In the hook, just add your callback to the
$tokenFunctions array and return true (returning false makes no sense)
$tokenFunctions: array(action => callback)
2011-03-20 13:31:22 +00:00
'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
the sites general information.
2011-03-24 11:11:15 +00:00
$module: the current ApiQuerySiteInfo module
2011-03-20 13:41:41 +00:00
&$results: array of results, add things here
2011-03-20 13:31:22 +00:00
2009-04-19 15:12:15 +00:00
'APIQueryUsersTokens': use this hook to add custom token to list=users.
Every token has an action, which will be used in the ustoken parameter
and in the output (actiontoken="..."), and a callback function which
should return the token, or false if the user isn't allowed to obtain
it. The prototype of the callback function is func($user) where $user
is the User object. In the hook, just add your callback to the
$tokenFunctions array and return true (returning false makes no sense)
$tokenFunctions: array(action => callback)
2010-10-28 19:20:21 +00:00
'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
Each service should have its own entry in the $apis array and have a
unique name, passed as key for the array that represents the service data.
In this data array, the key-value-pair identified by the apiLink key is
required.
&$apis: array of services
2009-05-28 17:05:09 +00:00
'ArticleAfterFetchContent': after fetching content of an article from
the database
2007-12-03 19:47:11 +00:00
$article: the article (object) being loaded from the database
$content: the content (string) of the article
2011-04-13 23:36:27 +00:00
'ArticleConfirmDelete': before writing the confirmation form for article
deletion
$article: the article (object) being deleted
$output: the OutputPage object ($wgOut)
&$reason: the reason (string) the article is being deleted
2010-12-11 05:32:48 +00:00
'ArticleContentOnDiff': before showing the article content below a diff.
Use this to change the content in this area or how it is loaded.
2010-10-26 22:34:18 +00:00
$diffEngine: the DifferenceEngine
$output: the OutputPage object ($wgOut)
2004-11-28 06:15:22 +00:00
'ArticleDelete': before an article is deleted
2011-07-25 16:44:57 +00:00
$article: the WikiPage (object) being deleted
2004-11-28 06:15:22 +00:00
$user: the user (object) deleting the article
$reason: the reason (string) the article is being deleted
2008-06-27 13:37:47 +00:00
$error: if the deletion was prohibited, the (raw HTML) error message to display
(added in 1.13)
2004-11-28 06:15:22 +00:00
'ArticleDeleteComplete': after an article is deleted
2011-07-25 16:44:57 +00:00
$article: the WikiPage that was deleted
2004-11-28 06:15:22 +00:00
$user: the user that deleted the article
$reason: the reason the article was deleted
2008-04-29 16:07:04 +00:00
$id: id of the article that was deleted
2004-11-28 06:15:22 +00:00
2009-05-28 17:05:09 +00:00
'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
was changed
2011-07-25 16:44:57 +00:00
$article: WikiPage (object) of the user talk page
2007-12-03 19:47:11 +00:00
2009-05-28 17:05:09 +00:00
'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
article has been changed
2011-07-25 16:44:57 +00:00
$article: the WikiPage (object)
2009-05-28 17:05:09 +00:00
$editInfo: data holder that includes the parser output ($editInfo->output) for
that page after the change
2008-09-27 10:52:49 +00:00
$changed: bool for if the page was changed
2009-05-28 17:05:09 +00:00
'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
recentchanges table, return false to not delete old entries
2011-07-25 16:44:57 +00:00
$article: WikiPage (object) being modified
2007-12-03 19:47:11 +00:00
2009-05-28 17:05:09 +00:00
'ArticleFromTitle': when creating an article object from a title object using
Wiki::articleFromTitle()
2007-12-03 19:47:11 +00:00
$title: title (object) used to create the article object
$article: article (object) that will be returned
2008-06-12 21:31:05 +00:00
'ArticleInsertComplete': After a new article is created
2011-07-25 16:44:57 +00:00
$article: WikiPage created
2007-07-22 23:16:48 +00:00
$user: User creating the article
$text: New content
$summary: Edit summary/comment
$isMinor: Whether or not the edit was marked as minor
$isWatch: (No longer used)
$section: (No longer used)
$flags: Flags passed to Article::doEdit()
$revision: New Revision of the article
2007-12-03 19:47:11 +00:00
'ArticleMergeComplete': after merging to article using Special:Mergehistory
$targetTitle: target title (object)
2009-06-18 02:13:42 +00:00
$destTitle: destination title (object)
2007-12-03 19:47:11 +00:00
'ArticlePageDataAfter': after loading data of an article from the database
2011-07-25 16:44:57 +00:00
$article: WikiPage (object) whose data were loaded
2007-12-03 19:47:11 +00:00
$row: row (object) returned from the database server
'ArticlePageDataBefore': before loading data of an article from the database
2011-07-25 16:44:57 +00:00
$article: WikiPage (object) that data will be loaded
2007-12-03 19:47:11 +00:00
$fields: fileds (array) to load from the database
2011-01-16 21:12:26 +00:00
'ArticlePrepareTextForEdit': called when preparing text to be saved
2011-07-25 16:44:57 +00:00
$article: the WikiPage being saved
2011-01-16 21:12:26 +00:00
$popts: parser options to be used for pre-save transformation
2004-11-28 00:20:37 +00:00
'ArticleProtect': before an article is protected
2011-07-25 16:44:57 +00:00
$article: the WikiPage being protected
2004-11-28 00:20:37 +00:00
$user: the user doing the protection
$protect: boolean whether this is a protect or an unprotect
$reason: Reason for protect
$moveonly: boolean whether this is for move only or not
'ArticleProtectComplete': after an article is protected
2011-07-25 16:44:57 +00:00
$article: the WikiPage that was protected
2004-11-28 00:20:37 +00:00
$user: the user who did the protection
$protect: boolean whether it was a protect or an unprotect
$reason: Reason for protect
$moveonly: boolean whether it was for move only or not
2009-06-18 02:13:42 +00:00
'ArticlePurge': before executing "&action=purge"
2011-07-25 16:44:57 +00:00
$article: WikiPage (object) to purge
2007-12-03 19:47:11 +00:00
2010-05-27 15:13:30 +00:00
'ArticleRevisionVisibilitySet': called when changing visibility of one or more
2008-03-22 17:29:44 +00:00
revision of an article
&$title: title object of the article
'ArticleRevisionUndeleted': after an article revision is restored
2007-12-07 22:51:00 +00:00
$title: the article title
$revision: the revision
$oldPageID: the page ID of the revision when archived (may be null)
2007-10-30 07:58:15 +00:00
'ArticleRollbackComplete': after an article rollback is completed
2011-07-25 16:44:57 +00:00
$article: the WikiPage that was edited
2007-10-30 07:58:15 +00:00
$user: the user who did the rollback
$revision: the revision the page was reverted back to
2009-01-04 12:27:08 +00:00
$current: the reverted revision
2007-10-30 07:58:15 +00:00
2004-11-28 06:45:24 +00:00
'ArticleSave': before an article is saved
2011-07-25 16:44:57 +00:00
$article: the WikiPage (object) being saved
2004-11-28 06:45:24 +00:00
$user: the user (object) saving the article
$text: the new article text
$summary: the article summary (comment)
$isminor: minor flag
$iswatch: watch flag
$section: section #
2007-07-22 23:16:48 +00:00
'ArticleSaveComplete': After an article has been updated
2011-07-25 16:44:57 +00:00
$article: WikiPage modified
2007-07-22 23:16:48 +00:00
$user: User performing the modification
$text: New content
$summary: Edit summary/comment
$isMinor: Whether or not the edit was marked as minor
$isWatch: (No longer used)
$section: (No longer used)
$flags: Flags passed to Article::doEdit()
$revision: New Revision of the article
2011-09-15 13:11:59 +00:00
$status: Status object about to be returned by doEdit()
2009-03-18 07:55:19 +00:00
$baseRevId: the rev ID (or false) this edit was based on
2007-07-22 23:16:48 +00:00
2007-12-03 19:47:11 +00:00
'ArticleUndelete': When one or more revisions of an article are restored
2007-01-18 07:44:25 +00:00
$title: Title corresponding to the article restored
$create: Whether or not the restoration caused the page to be created
(i.e. it didn't exist before)
2009-07-16 15:20:13 +00:00
$comment: The comment associated with the undeletion.
2007-01-18 07:44:25 +00:00
2009-05-28 17:05:09 +00:00
'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
before the user is redirected back to the page
2007-12-03 19:47:11 +00:00
&$article: the article
&$sectionanchor: The section anchor link (e.g. "#overview" )
&$extraq: Extra query parameters which can be added via hooked functions
2011-01-14 21:54:29 +00:00
'ArticleViewFooter': After showing the footer section of an ordinary page view
$article: Article object
2009-05-28 17:05:09 +00:00
'ArticleViewHeader': Before the parser cache is about to be tried for article
viewing.
2007-09-13 20:16:52 +00:00
&$article: the article
2007-06-03 22:34:53 +00:00
&$pcache: whether to try the parser cache or not
2011-09-24 21:12:26 +00:00
&$outputDone: whether the output for this page finished or not. Set to a ParserOutput
object to both indicate that the output is done and what parser output was used.
2007-06-03 22:34:53 +00:00
2009-05-28 17:05:09 +00:00
'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
follwed an redirect
2007-12-03 19:47:11 +00:00
$article: target article (object)
2007-08-15 22:13:03 +00:00
2011-08-11 17:21:31 +00:00
'ArticleViewCustom': allows to output the text of the article in a different format than wikitext
$text: text of the page
$title: title of the page
$output: reference to $wgOut
2008-05-17 09:06:35 +00:00
'AuthPluginAutoCreate': Called when creating a local account for an user logged
in from an external authentication method
$user: User object created locally
2006-11-30 07:47:34 +00:00
'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
Gives a chance for an extension to set it programattically to a variable class.
&$auth: the $wgAuth object, probably a stub
2007-12-23 18:33:46 +00:00
'AutopromoteCondition': check autopromote condition for user.
$type: condition type
$args: arguments
$user: user
$result: result of checking autopromote condition
2011-08-13 22:42:09 +00:00
'BacklinkCacheGetPrefix': allows to set prefix for a spefific link table
$table: table name
&$prefix: prefix
'BacklinkCacheGetConditions': allows to set conditions for query when links to certain title
are fetched
$table: table name
$title: title of the page to which backlinks are sought
&$conds: query conditions
2006-07-02 21:54:34 +00:00
'BadImage': When checking against the bad image list
$name: Image name being checked
&$bad: Whether or not the image is "bad"
Change $bad and return false to override. If an image is "bad", it is not
rendered inline in wiki pages or galleries in category pages.
2009-08-03 22:31:52 +00:00
'BeforeInitialize': before anything is initialized in performRequestForTitle()
&$title: Title being used for request
&$article: The associated Article object
&$output: OutputPage object
&$user: User
$request: WebRequest object
2009-11-17 20:52:04 +00:00
$mediaWiki: Mediawiki object
2009-08-03 22:31:52 +00:00
2007-08-28 21:53:50 +00:00
'BeforePageDisplay': Prior to outputting a page
2008-04-07 17:53:31 +00:00
&$out: OutputPage object
&$skin: Skin object
2007-08-28 21:53:50 +00:00
2011-03-24 01:44:48 +00:00
'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
2011-04-04 01:22:08 +00:00
$parser: Parser object
$nt: the image title
2011-09-06 18:11:53 +00:00
&$options: array of options to RepoGroup::findFile
2011-03-24 01:44:48 +00:00
&$descQuery: query string to add to thumbnail URL
2011-09-06 18:11:53 +00:00
If 'broken' is a key in $options then the file will appear as a broken thumbnail.
2007-06-01 13:17:24 +00:00
'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
2011-04-04 01:22:08 +00:00
$parser: Parser object
$title: title of the template
2007-06-01 13:17:24 +00:00
&$skip: skip this template and link it?
&$id: the id of the revision being parsed
'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
&$parser: Parser object
&$ig: ImageGallery object
2011-04-15 00:23:37 +00:00
'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user
&$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
&$injected_html: Any HTML to inject after the "logged in" message of a newly created user account
2011-03-18 22:28:19 +00:00
'BitmapHandlerTransform': before a file is transformed, gives extension the
possibility to transform it themselves
$handler: BitmapHandler
$image: File
&$scalerParams: Array with scaler parameters
&$mto: null, set to a MediaTransformOutput
2011-07-15 00:48:02 +00:00
'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
$block: Block object (which is set to be autoblocking)
&$blockIds: Array of block IDs of the autoblock
2004-11-27 23:57:55 +00:00
'BlockIp': before an IP address or user is blocked
$block: the Block object about to be saved
$user: the user _doing_ the block (not the one being blocked)
'BlockIpComplete': after an IP address or user is blocked
$block: the Block object that was saved
$user: the user who did the block (not the one being blocked)
2007-01-16 19:06:56 +00:00
'BookInformation': Before information output on Special:Booksources
$isbn: ISBN to show information for
$output: OutputPage object in use
2010-08-24 19:58:55 +00:00
'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
2010-08-24 20:12:15 +00:00
&$namespaces: Array of namespace numbers with corresponding canonical names
2009-11-06 16:49:41 +00:00
2007-08-28 21:53:50 +00:00
'CategoryPageView': before viewing a categorypage in CategoryPage::view
$catpage: CategoryPage instance
2007-11-06 01:16:25 +00:00
'ChangesListInsertArticleLink': Override or augment link to article in RC list.
2009-11-17 20:52:04 +00:00
&$changesList: ChangesList instance.
2007-11-06 01:16:25 +00:00
&$articlelink: HTML of link to article (already filled-in).
&$s: HTML of row that is being constructed.
&$rc: RecentChange instance.
$unpatrolled: Whether or not we are showing unpatrolled changes.
$watched: Whether or not the change is watched by the user.
2011-07-05 05:33:54 +00:00
'Collation::factory': Called if $wgCategoryCollation is an unknown collation
$collationName: Name of the collation in question
&$collationObject: Null. Replace with a subclass of the Collation class that implements
the collation given in $collationName.
2009-10-04 16:26:43 +00:00
'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
2009-10-06 22:14:40 +00:00
$user: user (object) whose email is being confirmed
2009-10-04 16:26:43 +00:00
2008-07-17 14:55:30 +00:00
'ContribsPager::getQueryInfo': Before the contributions query is about to run
2008-07-20 13:55:35 +00:00
&$pager: Pager object for contributions
2011-08-19 20:58:32 +00:00
&$queryInfo: The query for the contribs Pager
2008-07-17 14:55:30 +00:00
2008-07-20 13:55:35 +00:00
'ContributionsLineEnding': Called before a contributions HTML line is finished
$page: SpecialPage object for contributions
$ret: the HTML line
$row: the DB row for this line
2008-07-17 14:55:30 +00:00
2007-07-16 11:21:21 +00:00
'ContributionsToolLinks': Change tool links above Special:Contributions
$id: User identifier
$title: User page title
&$tools: Array of tool links
2007-01-20 19:51:21 +00:00
'CustomEditor': When invoking the page editor
$article: Article being edited
$user: User performing the edit
Return true to allow the normal editor to be used, or false
if implementing a custom editor, e.g. for a special namespace,
etc.
2009-07-19 20:03:13 +00:00
'DatabaseOraclePostInit': Called after initialising an Oracle database
&$db: the DatabaseOracle object
2011-05-25 22:01:08 +00:00
'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
$text: plaintext string to be output
$group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
2009-01-07 21:09:18 +00:00
'NewDifferenceEngine': Called when a new DifferenceEngine object is made
$title: the diff page title (nullable)
&$oldId: the actual old Id to use in the diff
&$newId: the actual new Id to use in the diff (0 means current)
$old: the ?old= param value from the url
$new: the ?new= param value from the url
2006-05-24 09:05:49 +00:00
'DiffViewHeader': called before diff display
$diff: DifferenceEngine object that's calling
$oldRev: Revision object of the "old" revision (may be null/invalid)
$newRev: Revision object of the "new" revision
2009-05-28 17:05:09 +00:00
'DisplayOldSubtitle': before creating subtitle when browsing old versions of
an article
2007-12-03 19:47:11 +00:00
$article: article (object) being viewed
$oldid: oldid (int) being viewed
2008-07-28 23:52:55 +00:00
'DoEditSectionLink': Override the HTML generated for section edit links
$skin: Skin object rendering the UI
$title: Title object for the title being linked to (may not be the same as
$wgTitle, if the section is included from a template)
$section: The designation of the section being pointed to, to be included in
the link, like "§ion=$section"
$tooltip: The default tooltip. Escape with htmlspecialchars() before using.
By default, this is wrapped in the 'editsectionhint' message.
2010-10-14 22:13:43 +00:00
&$result: The HTML to return, prefilled with the default plus whatever other
2008-07-28 23:52:55 +00:00
changes earlier hooks have made
2010-10-14 22:13:43 +00:00
$lang: The language code to use for the link in the wfMsg* functions
2008-07-28 23:52:55 +00:00
2007-12-10 12:51:45 +00:00
'EditFilter': Perform checks on an edit
$editor: Edit form (see includes/EditPage.php)
$text: Contents of the edit box
$section: Section being edited
&$error: Error message to return
2008-06-19 03:14:05 +00:00
$summary: Edit summary for page
2006-12-01 21:18:40 +00:00
2007-12-10 12:51:45 +00:00
'EditFilterMerged': Post-section-merge edit filter
2007-12-03 19:47:11 +00:00
$editor: EditPage instance (object)
2007-12-10 12:51:45 +00:00
$text: content of the edit box
2009-08-21 21:51:29 +00:00
&$error: error message to return
2008-06-19 03:14:05 +00:00
$summary: Edit summary for page
2007-12-03 19:47:11 +00:00
2009-05-28 17:05:09 +00:00
'EditFormPreloadText': Allows population of the edit form when creating
new pages
2006-06-14 13:12:08 +00:00
&$text: Text to preload with
&$title: Title object representing the page being created
2010-02-20 17:05:56 +00:00
'EditFormInitialText': Allows modifying the edit form when editing existing
pages
$editPage: EditPage object
2007-12-10 12:51:45 +00:00
'EditPage::attemptSave': called before an article is
2011-05-12 20:16:51 +00:00
saved, that is before Article::doEdit() is called
2009-08-21 21:51:29 +00:00
$editpage_Obj: the current EditPage object
2007-12-10 12:51:45 +00:00
2009-07-08 18:47:46 +00:00
'EditPage::importFormData': allow extensions to read additional data
posted in the form
$editpage: EditPage instance
$request: Webrequest
return value is ignored (should always return true)
2007-04-02 21:53:06 +00:00
'EditPage::showEditForm:fields': allows injection of form field into edit form
&$editor: the EditPage instance for reference
&$out: an OutputPage instance to write to
return value is ignored (should always return true)
2007-12-10 12:51:45 +00:00
'EditPage::showEditForm:initial': before showing the edit form
2007-12-03 19:47:11 +00:00
$editor: EditPage instance (object)
2009-05-28 17:05:09 +00:00
Return false to halt editing; you'll need to handle error messages, etc.
yourself. Alternatively, modifying $error and returning true will cause the
contents of $error to be echoed at the top of the edit form as wikitext.
Return true without altering $error to allow the edit to proceed.
2007-06-05 01:50:33 +00:00
2008-04-15 14:47:04 +00:00
'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
when there's an edit conflict. Return false to halt normal diff output; in
this case you're responsible for computing and outputting the entire "conflict"
part, i.e., the "difference between revisions" and "your text" headers and
sections.
&$editor: EditPage instance
&$out: OutputPage instance
2009-05-28 17:05:09 +00:00
'EditPageBeforeEditButtons': allows modifying the edit buttons below the
textarea in the edit form
2008-02-13 00:31:02 +00:00
&$editpage: The current EditPage object
2008-02-13 00:13:57 +00:00
&$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
2008-12-20 01:15:40 +00:00
&$tabindex: HTML tabindex of the last edit check/button
2009-05-28 17:05:09 +00:00
'EditPageBeforeEditChecks': allows modifying the edit checks below the
textarea in the edit form
2008-12-20 01:15:40 +00:00
&$editpage: The current EditPage object
&$checks: Array of edit checks like "watch this page"/"minor edit"
&$tabindex: HTML tabindex of the last edit check/button
2008-02-13 00:13:57 +00:00
2009-07-07 16:45:12 +00:00
'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
textarea in the edit form
&$toolbar: The toolbar HTMl
2009-06-24 16:49:28 +00:00
'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
$title: title of page being edited
&$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
2010-02-20 17:05:56 +00:00
'EditPageGetDiffText': Allow modifying the wikitext that will be used in
"Show changes"
$editPage: EditPage object
&$newtext: wikitext that will be used as "your version"
'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
$editPage: EditPage object
&$toparse: wikitext that will be parsed
2010-01-18 00:58:22 +00:00
'EditPageNoSuchSection': When a section edit request is given for an non-existent section
&$editpage: The current EditPage object
&$res: the HTML of the error text
2009-06-24 16:49:28 +00:00
'EditPageTosSummary': Give a chance for site and per-namespace customizations
of terms of service summary link that might exist separately from the copyright
notice.
$title: title of page being edited
&$msg: localization message name, overridable. Default is 'editpage-tos-summary'
2008-07-28 23:52:55 +00:00
'EditSectionLink': Do not use, use DoEditSectionLink instead.
2007-06-05 01:50:33 +00:00
$skin: Skin rendering the UI
$title: Title being linked to
$section: Section to link to
$link: Default link
2010-10-14 22:13:43 +00:00
&$result: Result (alter this to override the generated links)
$lang: The language code to use for the link in the wfMsg* functions
2006-05-06 21:41:53 +00:00
2006-05-02 20:07:54 +00:00
'EmailConfirmed': When checking that the user's email address is "confirmed"
$user: User being checked
$confirmed: Whether or not the email address is confirmed
This runs before the other checks, such as anonymity and the real check; return
true to allow those checks to occur, and false if checking is done.
2004-11-29 04:23:12 +00:00
'EmailUser': before sending email from one user to another
$to: address of receiving user
$from: address of sending user
$subject: subject of the mail
$text: text of the mail
2010-04-13 17:33:22 +00:00
'EmailUserCC': before sending the copy of the email to the author
$to: address of receiving user
$from: address of sending user
$subject: subject of the mail
$text: text of the mail
2004-11-29 04:23:12 +00:00
'EmailUserComplete': after sending email from one user to another
$to: address of receiving user
$from: address of sending user
$subject: subject of the mail
$text: text of the mail
2010-04-13 17:33:22 +00:00
'EmailUserForm': after building the email user form object
$form: HTMLForm object
2009-05-28 12:32:43 +00:00
'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
$user: The user who is trying to email another user.
$editToken: The user's edit token.
&$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
2011-10-19 17:15:05 +00:00
'ExemptFromAccountCreationThrottle': Exemption from the account creation throttle
2011-08-21 16:38:02 +00:00
$ip: The ip address of the user
2011-06-13 14:55:03 +00:00
'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
&$extTypes: associative array of extensions types
2009-05-28 17:05:09 +00:00
'FetchChangesList': When fetching the ChangesList derivative for
a particular user
2011-04-03 11:33:10 +00:00
$user: User the list is being fetched for
2006-06-21 00:18:55 +00:00
&$skin: Skin object to be used with the list
2009-05-28 17:05:09 +00:00
&$list: List object (defaults to NULL, change it to an object
instance and return false override the list derivative used)
2006-06-21 00:18:55 +00:00
2008-03-01 13:35:01 +00:00
'FileDeleteComplete': When a file is deleted
$file: reference to the deleted file
$oldimage: in case of the deletion of an old image, the name of the old file
2009-05-28 17:05:09 +00:00
$article: in case all revisions of the file are deleted a reference to the
article associated with the file.
2008-03-01 13:35:01 +00:00
$user: user who performed the deletion
$reason: reason
2007-04-10 02:18:42 +00:00
'FileUpload': When a file upload occurs
$file : Image object representing the file that was uploaded
2010-08-31 13:16:42 +00:00
$reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
$hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
2007-04-10 02:18:42 +00:00
2008-03-01 13:35:01 +00:00
'FileUndeleteComplete': When a file is undeleted
$title: title object to the file
$fileVersions: array of undeleted versions. Empty if all versions were restored
$user: user who performed the undeletion
$reason: reason
2009-05-28 17:05:09 +00:00
'GetAutoPromoteGroups': When determining which autopromote groups a user
is entitled to be in.
2008-06-04 06:04:13 +00:00
&$user: user to promote.
&$promote: groups that will be added.
2007-12-03 19:47:11 +00:00
'GetBlockedStatus': after loading blocking status of an user from the database
$user: user (object) being checked
2008-04-10 14:28:56 +00:00
'GetCacheVaryCookies': get cookies that should vary cache options
$out: OutputPage object
&$cookies: array of cookies name, add a value to it if you want to add a cookie
that have to vary cache options
2011-08-19 14:05:00 +00:00
'GetCanonicalURL': modify fully-qualified URLs used for IRC and e-mail notifications
$title: Title object of page
$url: string value as output (out parameter, can modify)
$query: query options passed to Title::getCanonicalURL()
2011-09-05 08:31:51 +00:00
$variant: variant passed to Title::getCanonicalURL()
2011-08-19 14:05:00 +00:00
2011-07-06 00:38:40 +00:00
'GetDefaultSortkey': Override the default sortkey for a page.
$title: Title object that we need to get a sortkey for
&$sortkey: Sortkey to use.
2007-12-10 12:51:45 +00:00
'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
$title: Title object of page
$url: string value as output (out parameter, can modify)
$query: query options passed to Title::getFullURL()
2011-09-05 08:31:51 +00:00
$variant: variant passed to Title::getFullURL()
2007-12-10 12:51:45 +00:00
2005-12-26 07:14:42 +00:00
'GetInternalURL': modify fully-qualified URLs used for squid cache purging
$title: Title object of page
$url: string value as output (out parameter, can modify)
$query: query options passed to Title::getInternalURL()
2011-09-05 08:31:51 +00:00
$variant: variant passed to Title::getFullURL()
2005-12-26 07:14:42 +00:00
2010-09-11 13:45:51 +00:00
'GetIP': modify the ip of the current user (called only once)
&$ip: string holding the ip as determined so far
2007-11-22 15:54:18 +00:00
'GetLinkColours': modify the CSS class of an array of page links
2009-05-28 17:05:09 +00:00
$linkcolour_ids: array of prefixed DB keys of the pages linked to,
indexed by page_id.
2007-11-22 15:54:18 +00:00
&$colours: (output) array of CSS classes, indexed by prefixed DB keys
2011-08-12 19:23:43 +00:00
'GetLocalURL': modify local URLs as output into page links. Note that if you
are working with internal urls (non-interwiki) then it may be preferable
to work with the GetLocalURL::Internal or GetLocalURL::Article hooks as
GetLocalURL can be buggy for internal urls on render if you do not
re-implement the horrible hack that Title::getLocalURL uses
in your own extension.
2005-12-26 07:14:42 +00:00
$title: Title object of page
2011-08-12 19:23:43 +00:00
&$url: string value as output (out parameter, can modify)
$query: query options passed to Title::getLocalURL()
2011-09-05 08:31:51 +00:00
$variant: variant passed to Title::getLocalURL()
2011-08-12 19:23:43 +00:00
'GetLocalURL::Internal': modify local URLs to internal pages.
$title: Title object of page
&$url: string value as output (out parameter, can modify)
2005-12-26 07:14:42 +00:00
$query: query options passed to Title::getLocalURL()
2011-09-05 08:31:51 +00:00
$variant: variant passed to Title::getLocalURL()
2011-08-12 19:23:43 +00:00
'GetLocalURL::Article': modify local URLs specifically pointing to article paths
without any fancy queries or variants.
$title: Title object of page
&$url: string value as output (out parameter, can modify)
2005-12-26 07:14:42 +00:00
2011-04-16 01:23:15 +00:00
'GetMetadataVersion': modify the image metadata version currently in use. This is
used when requesting image metadata from a ForiegnApiRepo. Media handlers
that need to have versioned metadata should add an element to the end of
the version array of the form 'handler_name=version'. Most media handlers
won't need to do this unless they broke backwards compatibility with a
previous version of the media handler metadata output.
&$version: Array of version strings
2009-04-24 01:31:17 +00:00
'GetPreferences': modify user preferences
$user: User whose preferences are being modified.
&$preferences: Preferences description array, to be fed to an HTMLForm object
2008-01-02 02:05:01 +00:00
'getUserPermissionsErrors': Add a permissions error when permissions errors are
checked for. Use instead of userCan for most cases. Return false if the
user can't do it, and populate $result with the reason in the form of
array( messagename, param1, param2, ... ). For consistency, error messages
should be plain text with no special coloring, bolding, etc. to show that
they're errors; presenting them properly to the user as errors is done by
the caller.
2007-10-10 09:56:47 +00:00
$title: Title object being checked against
$user : Current user object
$action: Action being checked
$result: User permissions error to add. If none, return true.
2008-01-14 13:50:55 +00:00
'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
if expensive checks are enabled.
2008-02-26 17:20:39 +00:00
'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
image insertion. You can skip the default logic entirely by returning
false, or just modify a few things using call-by-reference.
2009-11-17 20:52:04 +00:00
&$skin: Skin object
2008-02-26 17:20:39 +00:00
&$title: Title object of the image
&$file: File object, or false if it doesn't exist
&$frameParams: Various parameters with special meanings; see documentation in
includes/Linker.php for Linker::makeImageLink2
&$handlerParams: Various parameters with special meanings; see documentation in
includes/Linker.php for Linker::makeImageLink2
&$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
&$res: Final HTML output, used if you return false
2008-05-17 00:08:31 +00:00
'ImageOpenShowImageInlineBefore': Call potential extension just before showing
the image on an image page
$imagePage: ImagePage object ($this)
$output: $wgOut
2009-11-07 09:31:16 +00:00
'ImagePageAfterImageLinks': called after the image links section on an image
page is built
$imagePage: ImagePage object ($this)
&$html: HTML for the hook to add
2008-05-17 00:08:31 +00:00
'ImagePageFileHistoryLine': called when a file history line is contructed
$file: the file
$line: the HTML of the history line
$css: the line CSS class
2008-05-24 20:51:08 +00:00
'ImagePageFindFile': called when fetching the file associated with an image page
$page: ImagePage object
&$file: File object
&$displayFile: displayed File object
2009-11-08 11:09:20 +00:00
'ImagePageShowTOC': called when the file toc on an image page is generated
$page: ImagePage object
&$toc: Array of <li> strings
2009-11-07 10:33:10 +00:00
'ImgAuthBeforeStream': executed before file is streamed to user, but only when
using img_auth.php
&$title: the Title object of the file as it would appear for the upload page
&$path: the original file and path name when img_auth was invoked by the the web
server
&$name: the name only component of the file
&$result: The location to pass back results of the hook routine (only used if
failed)
$result[0]=The index of the header message
$result[1]=The index of the body text message
$result[2 through n]=Parameters passed to body text message. Please note the
header message cannot receive/use parameters.
2010-07-03 14:33:09 +00:00
'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
$reader: XMLReader object
$logInfo: Array of information
Return false to stop further processing of the tag
'ImportHandlePageXMLTag': When parsing a XML tag in a page
$reader: XMLReader object
$pageInfo: Array of information
Return false to stop further processing of the tag
'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
$reader: XMLReader object
$revInfo: Array of information
Return false to stop further processing of the tag
'ImportHandleToplevelXMLTag': When parsing a top level XML tag
$reader: XMLReader object
Return false to stop further processing of the tag
'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
$reader: XMLReader object
$revisionInfo: Array of information
Return false to stop further processing of the tag
2009-11-07 10:33:10 +00:00
2008-07-04 09:38:12 +00:00
'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
$title: Title object ($wgTitle)
$request: WebRequest
$ignoreRedirect: boolean to skip redirect check
$target: Title/string of redirect target
2008-12-22 07:35:56 +00:00
$article: Article object
2008-07-04 09:38:12 +00:00
2011-03-17 15:51:19 +00:00
'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
Return true without providing an interwiki to continue interwiki search.
$prefix: interwiki prefix we are looking for.
&$iwData: output array describing the interwiki with keys iw_url, iw_local,
iw_trans and optionally iw_api and iw_wikiid.
2009-05-28 17:05:09 +00:00
'InternalParseBeforeLinks': during Parser's internalParse method before links
but after noinclude/includeonly/onlyinclude and other processing.
2009-11-17 20:52:04 +00:00
&$parser: Parser object
2007-04-25 21:23:43 +00:00
&$text: string containing partially parsed text
2009-11-17 20:52:04 +00:00
&$stripState: Parser's internal StripState object
2007-04-25 21:23:43 +00:00
2009-10-04 16:26:43 +00:00
'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
2009-10-06 22:14:40 +00:00
$user: user (object) whose email is being invalidated
2009-10-04 16:26:43 +00:00
2011-08-19 14:05:00 +00:00
'IRCLineURL': When constructing the URL to use in an IRC notification.
Callee may modify $url and $query, URL will be constructed as $url . $query
&$url: URL to index.php
&$query: Query string
2007-12-03 19:47:11 +00:00
'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
$article: article (object) being checked
'IsTrustedProxy': Override the result of wfIsTrustedProxy()
$ip: IP being check
$result: Change this value to override the result of wfIsTrustedProxy()
2007-10-21 17:15:37 +00:00
'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
tance to return false if the domain name doesn't match your organization
$addr: The e-mail address entered by the user
&$result: Set this and return false to override the internal checks
2007-07-17 16:44:40 +00:00
'isValidPassword': Override the result of User::isValidPassword()
2007-10-21 17:15:37 +00:00
$password: The password entered by the user
2009-10-19 03:01:11 +00:00
&$result: Set this and return false to override the internal checks
2007-07-17 22:30:52 +00:00
$user: User the password is being validated for
2007-07-17 16:44:40 +00:00
2011-08-30 13:24:27 +00:00
'LanguageGetNamespaces': Provide custom ordering for namespaces or
2011-08-30 13:59:54 +00:00
remove namespaces. Do not use this hook to add namespaces. Use
CanonicalNamespaces for that.
2011-08-30 13:24:27 +00:00
&$namespaces: Array of namespaces indexed by their numbers
* Introduced a new system for localisation caching. The system is based around fast fetches of individual messages, minimising memory overhead and startup time in the typical case. It handles both core messages (formerly in Language.php) and extension messages (formerly in MessageCache.php). Profiling indicates a significant win for average throughput.
* The serialized message cache, which would have been redundant, has been removed. Similar performance characteristics can be achieved with $wgLocalisationCacheConf['manualRecache'] = true;
* Added a maintenance script rebuildLocalisationCache.php for offline rebuilding of the localisation cache.
* Extension i18n files can now contain any of the variables which can be set in Messages*.php. It is possible, and recommended, to use this feature instead of the hooks for special page aliases and magic words.
* $wgExtensionAliasesFiles, LanguageGetMagic and LanguageGetSpecialPageAliases are retained for backwards compatibility. $wgMessageCache->addMessages() and related functions have been removed. wfLoadExtensionMessages() is a no-op and can continue to be called for b/c.
* Introduced $wgCacheDirectory as a default location for the various local caches that have accumulated. Suggested $IP/cache as a good place for it in the default LocalSettings.php and created this directory with a deny-all .htaccess.
* Patched Exception.php to avoid using the message cache when an exception is thrown from within LocalisationCache, since this tends to fail horribly.
* Removed Language::getLocalisationArray(), Language::loadLocalisation(), Language::load()
* Fixed FileDependency::__sleep()
* In Cdb.php, fixed newlines in debug messages
In MessageCache::get():
* Replaced calls to $wgContLang capitalisation functions with plain PHP functions, reducing the typical case from 99us to 93us. Message cache keys are already documented as being restricted to ASCII.
* Implemented a more efficient way to filter out bogus language codes, reducing the "foo/en" case from 430us to 101us
* Optimised wfRunHooks() in the typical do-nothing case, from ~30us to ~3us. This reduced MessageCache::get() typical case time from 93us to 38us.
* Removed hook MessageNotInMwNs to save an extra 3us per cache hit. Reimplemented the only user (LocalisationUpdate) using the new hook LocalisationCacheRecache.
2009-06-28 07:11:43 +00:00
'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
$wgExtensionMessagesFiles instead.
Use this to define synonyms of magic words depending of the language
2007-12-10 12:51:45 +00:00
$magicExtensions: associative array of magic words synonyms
$lang: laguage code (string)
* Introduced a new system for localisation caching. The system is based around fast fetches of individual messages, minimising memory overhead and startup time in the typical case. It handles both core messages (formerly in Language.php) and extension messages (formerly in MessageCache.php). Profiling indicates a significant win for average throughput.
* The serialized message cache, which would have been redundant, has been removed. Similar performance characteristics can be achieved with $wgLocalisationCacheConf['manualRecache'] = true;
* Added a maintenance script rebuildLocalisationCache.php for offline rebuilding of the localisation cache.
* Extension i18n files can now contain any of the variables which can be set in Messages*.php. It is possible, and recommended, to use this feature instead of the hooks for special page aliases and magic words.
* $wgExtensionAliasesFiles, LanguageGetMagic and LanguageGetSpecialPageAliases are retained for backwards compatibility. $wgMessageCache->addMessages() and related functions have been removed. wfLoadExtensionMessages() is a no-op and can continue to be called for b/c.
* Introduced $wgCacheDirectory as a default location for the various local caches that have accumulated. Suggested $IP/cache as a good place for it in the default LocalSettings.php and created this directory with a deny-all .htaccess.
* Patched Exception.php to avoid using the message cache when an exception is thrown from within LocalisationCache, since this tends to fail horribly.
* Removed Language::getLocalisationArray(), Language::loadLocalisation(), Language::load()
* Fixed FileDependency::__sleep()
* In Cdb.php, fixed newlines in debug messages
In MessageCache::get():
* Replaced calls to $wgContLang capitalisation functions with plain PHP functions, reducing the typical case from 99us to 93us. Message cache keys are already documented as being restricted to ASCII.
* Implemented a more efficient way to filter out bogus language codes, reducing the "foo/en" case from 430us to 101us
* Optimised wfRunHooks() in the typical do-nothing case, from ~30us to ~3us. This reduced MessageCache::get() typical case time from 93us to 38us.
* Removed hook MessageNotInMwNs to save an extra 3us per cache hit. Reimplemented the only user (LocalisationUpdate) using the new hook LocalisationCacheRecache.
2009-06-28 07:11:43 +00:00
'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
listed in $wgExtensionMessagesFiles instead.
Use to define aliases of special pages names depending of the language
2007-12-10 12:51:45 +00:00
$specialPageAliases: associative array of magic words synonyms
$lang: laguage code (string)
2010-12-31 18:18:57 +00:00
'LanguageGetTranslatedLanguageNames': Provide translated language names.
&$names: array of language code => language name
$code language of the preferred translations
2008-08-05 17:05:59 +00:00
'LinkBegin': Used when generating internal and interwiki links in
Linker::link(), before processing starts. Return false to skip default proces-
sing and return $ret. See documentation for Linker::link() for details on the
expected meanings of parameters.
$skin: the Skin object
$target: the Title that the link is pointing to
2011-05-09 02:55:17 +00:00
&$html: the contents that the <a> tag should have (raw HTML); null means "de-
2008-08-05 17:05:59 +00:00
fault"
&$customAttribs: the HTML attributes that the <a> tag should have, in associa-
tive array form, with keys and values unescaped. Should be merged with de-
fault values, with a value of false meaning to suppress the attribute.
&$query: the query string to add to the generated URL (the bit after the "?"),
in associative array form, with keys and values unescaped.
2008-09-14 00:49:52 +00:00
&$options: array of options. Can include 'known', 'broken', 'noclasses'.
2008-08-05 17:05:59 +00:00
&$ret: the value to return if your hook returns false.
'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
just before the function returns a value. If you return true, an <a> element
2011-05-09 02:55:17 +00:00
with HTML attributes $attribs and contents $html will be returned. If you re-
2008-08-05 17:05:59 +00:00
turn false, $ret will be returned.
$skin: the Skin object
$target: the Title object that the link is pointing to
$options: the options. Will always include either 'known' or 'broken', and may
include 'noclasses'.
2011-05-09 02:55:17 +00:00
&$html: the final (raw HTML) contents of the <a> tag, after processing.
2008-08-05 17:05:59 +00:00
&$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
ciative array form.
&$ret: the value to return if your hook returns false.
2009-05-28 17:05:09 +00:00
'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
before the return
2008-06-24 14:32:49 +00:00
&$url: the image url
2008-07-02 01:05:08 +00:00
&$alt: the image's alt text
2008-06-24 14:32:49 +00:00
&$img: the new image HTML (if returning false)
2009-05-28 17:05:09 +00:00
'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
before the return
2008-06-08 21:58:29 +00:00
&$url: the link url
&$text: the link text
&$link: the new link HTML (if returning false)
2009-03-09 13:55:45 +00:00
&$attribs: the attributes to be applied.
$linkType: The external link type
2008-06-08 21:58:29 +00:00
2009-05-28 17:05:09 +00:00
'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
actual update
2010-03-09 20:40:00 +00:00
&$linksUpdate: the LinksUpdate object
2008-02-09 12:32:32 +00:00
2009-05-28 17:05:09 +00:00
'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
completed
2010-03-09 20:40:00 +00:00
&$linksUpdate: the LinksUpdate object
2008-02-09 12:32:32 +00:00
2007-07-18 08:49:24 +00:00
'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
2010-03-09 20:40:00 +00:00
&$linksUpdate: the LinksUpdate object
2007-07-18 08:49:24 +00:00
2009-01-28 19:08:18 +00:00
'ListDefinedTags': When trying to find all defined tags.
&$tags: The list of tags.
2010-08-15 18:55:08 +00:00
'LoadExtensionSchemaUpdates': called during database installation and updates
&updater: A DatabaseUpdater subclass
2007-12-03 19:47:11 +00:00
2008-06-08 17:39:24 +00:00
'LocalFile::getHistory': called before file history query performed
2011-10-28 22:21:03 +00:00
$file: the File object
2008-06-08 17:39:24 +00:00
$tables: tables
$fields: select fields
$conds: conditions
$opts: query options
$join_conds: JOIN conditions
2011-10-28 22:21:03 +00:00
'LocalFilePurgeThumbnails': called before thumbnails for a local file a purged
$file: the File object
$type: either "current" or "archive"
2009-07-19 20:03:13 +00:00
'LocalisationCacheRecache': Called when loading the localisation data into cache
$cache: The LocalisationCache object
$code: language code
&$alldata: The localisation data from core and extensions
2011-09-16 23:14:13 +00:00
'LogEventsListShowLogExtract': called before the string is added to OutputPage. Returning false will prevent the string from being added to the OutputPage
&$s: html string to show for the log extract
2011-09-29 19:03:57 +00:00
$types: String or Array Log types to show
$page: String or Title The page title to show log entries for
2011-09-16 23:14:13 +00:00
$user: String The user who made the log entries
$param: Associative Array with the following additional options:
- lim Integer Limit of items to show, default is 50
- conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
- showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty if set to true (default), "No matching items in log" is displayed if loglist is empty
- msgKey Array If you want a nice box with a message, set this to the key of the message. First element is the message key, additional optional elements are parameters for the key that are processed with wgMsgExt and option 'parse'
- offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset
- wrap String Wrap the message in html (usually something like "<div ...>$1</div>").
- flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
2009-05-28 17:05:09 +00:00
'LoginAuthenticateAudit': a login attempt for a valid user account either
succeeded or failed. No return data is accepted; this hook is for auditing only.
2007-05-07 21:54:06 +00:00
$user: the User object being authenticated against
$password: the password being submitted and found wanting
2009-09-26 00:49:32 +00:00
$retval: a LoginForm class constant with authenticateUserData() return
2009-05-28 17:05:09 +00:00
value (SUCCESS, WRONG_PASS, etc)
2007-05-07 21:54:06 +00:00
2007-11-01 07:02:02 +00:00
'LogLine': Processes a single log entry on Special:Log
2009-05-28 17:05:09 +00:00
$log_type: string for the type of log entry (e.g. 'move'). Corresponds to
logging.log_type database field.
$log_action: string for the type of log action (e.g. 'delete', 'block',
'create2'). Corresponds to logging.log_action database field.
$title: Title object that corresponds to logging.log_namespace and
logging.log_title database fields.
$paramArray: Array of parameters that corresponds to logging.log_params field.
Note that only $paramArray[0] appears to contain anything.
&$comment: string that corresponds to logging.log_comment database field, and
which is displayed in the UI.
2007-11-01 07:02:02 +00:00
&$revert: string that is displayed in the UI, similar to $comment.
2009-06-18 02:13:42 +00:00
$time: timestamp of the log entry (added in 1.12)
2007-11-01 07:02:02 +00:00
2011-06-13 14:55:03 +00:00
'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
$refreshLinks: RefreshLinks object
2009-05-28 17:05:09 +00:00
'MagicWordMagicWords': When defining new magic word.
2009-08-14 11:48:40 +00:00
DEPRECATED: use $magicWords in a file listed in
$wgExtensionMessagesFiles instead.
2007-12-03 19:47:11 +00:00
$magicWords: array of strings
2009-02-10 12:48:58 +00:00
'MagicWordwgVariableIDs': When definig new magic words IDs.
2007-12-03 19:47:11 +00:00
$variableIDs: array of strings
2009-05-28 17:05:09 +00:00
'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
2011-01-09 11:44:52 +00:00
is executed. Ideally, this hook should only be used to add variables that
depend on the current page/request; static configuration should be added
2011-02-12 17:15:24 +00:00
through ResourceLoaderGetConfigVars instead.
2009-06-18 02:13:42 +00:00
&$vars: variable (or multiple variables) to be added into the output
2009-05-28 17:05:09 +00:00
of Skin::makeVariablesScript
2011-09-01 17:23:13 +00:00
&$out: The OutputPage which called the hook,
can be used to get the real title
2008-08-01 22:38:11 +00:00
2006-01-03 15:45:36 +00:00
'MarkPatrolled': before an edit is marked patrolled
2008-12-23 20:56:19 +00:00
$rcid: ID of the revision to be marked patrolled
2006-01-03 15:45:36 +00:00
$user: the user (object) marking the revision as patrolled
$wcOnlySysopsCanPatrol: config setting indicating whether the user
2009-05-28 17:05:09 +00:00
needs to be a sysop in order to mark an edit patrolled
2006-01-03 15:45:36 +00:00
'MarkPatrolledComplete': after an edit is marked patrolled
$rcid: ID of the revision marked as patrolled
$user: user (object) who marked the edit patrolled
$wcOnlySysopsCanPatrol: config setting indicating whether the user
2009-05-28 17:05:09 +00:00
must be a sysop to patrol the edit
2006-01-03 15:45:36 +00:00
2007-11-06 01:16:25 +00:00
'MediaWikiPerformAction': Override MediaWiki::performAction().
2007-12-03 19:47:11 +00:00
Use this to do something completely different, after the basic
globals have been set up, but before ordinary actions take place.
2009-11-17 20:52:04 +00:00
$output: $wgOut
2007-11-06 01:16:25 +00:00
$article: $wgArticle
2009-11-17 20:52:04 +00:00
$title: $wgTitle
$user: $wgUser
2007-11-06 01:16:25 +00:00
$request: $wgRequest
2009-11-17 20:52:04 +00:00
$mediaWiki: The $mediawiki object
2007-11-06 01:16:25 +00:00
2007-12-03 19:47:11 +00:00
'MessagesPreLoad': When loading a message from the database
$title: title of the message (string)
$message: value (string), change it to the message you want to define
2009-05-28 17:05:09 +00:00
'MessageCacheReplace': When a message page is changed.
Useful for updating caches.
2009-04-08 14:23:14 +00:00
$title: name of the page changed.
$text: new contents of the page.
2009-07-27 17:57:51 +00:00
'ModifyExportQuery': Modify the query used by the exporter.
$db: The database object to be queried.
&$tables: Tables in the query.
&$conds: Conditions in the query.
&$opts: Options for the query.
&$join_conds: Join conditions for the query.
2009-05-28 17:05:09 +00:00
'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
been rendered (useful for adding more)
2010-06-08 14:52:15 +00:00
Note: this is only run for the Monobook skin. This hook is deprecated and
may be removed in the future. To add items to the toolbox you should use
the SkinTemplateToolboxEnd hook instead, which works for all
2010-07-03 14:33:09 +00:00
"SkinTemplate"-type skins.
2007-12-10 12:51:45 +00:00
$tools: array of tools
2010-12-06 17:47:53 +00:00
'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
and returning it for the skin to output. You can add items to the toolbox while
still letting the skin make final decisions on skin-specific markup conventions
using this hook.
&$sk: The BaseTemplate base skin template
&$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
BaseTemplate::makeListItem for details on the format of individual
items inside of this array
2009-05-28 17:05:09 +00:00
'NewRevisionFromEditComplete': called when a revision was inserted
due to an edit
2011-07-25 16:44:57 +00:00
$article: the WikiPage edited
2008-05-17 17:53:46 +00:00
$rev: the new revision
$baseID: the revision ID this was based off, if any
2008-11-27 18:32:29 +00:00
$user: the editing user
2008-05-17 17:53:46 +00:00
2008-07-07 22:37:42 +00:00
'NormalizeMessageKey': Called before the software gets the text of a message
2009-05-28 17:05:09 +00:00
(stuff in the MediaWiki: namespace), useful for changing WHAT message gets
displayed
&$key: the message being looked up. Change this to something else to change
what message gets displayed (string)
2008-07-07 22:37:42 +00:00
&$useDB: whether or not to look up the message in the database (bool)
&$langCode: the language code to get the message for (string) - or -
2009-05-28 17:05:09 +00:00
whether to use the content language (true) or site language (false) (bool)
&$transform: whether or not to expand variables and templates
in the message (bool)
2008-07-07 22:37:42 +00:00
2008-09-03 22:13:03 +00:00
'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
&$changeslist: The OldChangesList instance.
&$s: HTML of the form "<li>...</li>" containing one RC entry.
&$rc: The RecentChange object.
2008-07-01 23:31:24 +00:00
'OpenSearchUrls': Called when constructing the OpenSearch description XML.
Hooks can alter or append to the array of URLs for search & suggestion formats.
&$urls: array of associative arrays with Url element attributes
2009-12-30 08:51:25 +00:00
'OtherBlockLogLink': Get links to the block log from extensions which blocks
users and/or IP addresses too
$otherBlockLink: An array with links to other block logs
$ip: The requested IP address or username
2006-01-13 17:00:05 +00:00
'OutputPageBeforeHTML': a page has been processed by the parser and
2009-06-18 02:13:42 +00:00
the resulting HTML is about to be displayed.
$parserOutput: the parserOutput (object) that corresponds to the page
2006-01-13 17:00:05 +00:00
$text: the text that will be displayed, in HTML (string)
2010-10-04 05:38:48 +00:00
'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
2010-10-03 14:12:41 +00:00
tag to allow for extensions to add attributes to the body of the page they might
need. Or to allow building extensions to add body classes that aren't of high
enough demand to be included in core.
$out: The OutputPage which called the hook, can be used to get the real title
$sk: The Skin that called OutputPage::headElement
&$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2009-05-28 17:05:09 +00:00
'OutputPageCheckLastModified': when checking if the page has been modified
since the last visit
&$modifiedTimes: array of timestamps.
The following keys are set: page, user, epoch
2008-09-04 20:38:08 +00:00
2007-12-03 19:47:11 +00:00
'OutputPageParserOutput': after adding a parserOutput to $wgOut
$out: OutputPage instance (object)
$parserOutput: parserOutput instance being added in $out
2009-05-28 17:05:09 +00:00
'OutputPageMakeCategoryLinks': links are about to be generated for the page's
categories. Implementations should return false if they generate the category
links, so the default link generation is skipped.
2008-07-02 20:02:51 +00:00
$out: OutputPage instance (object)
2009-05-28 17:05:09 +00:00
$categories: associative array, keys are category names, values are category
types ("normal" or "hidden")
$links: array, intended to hold the result. Must be an associative array with
category types as keys and arrays of HTML links as values.
2008-07-02 20:02:51 +00:00
2011-08-11 14:52:57 +00:00
'PageContentLanguage': allows changing the language in which the content of
a page is written. Defaults to the wiki content language ($wgContLang).
$title: Title object
&$pageLang: the page content language (either an object or a language code)
$wgLang: the user language
2007-03-25 23:42:09 +00:00
'PageHistoryBeforeList': When a history page list is about to be constructed.
2007-03-25 23:20:48 +00:00
$article: the article that the history is loading for
2007-03-25 23:42:09 +00:00
'PageHistoryLineEnding' : right before the end <li> is added to a history line
2007-03-25 23:20:48 +00:00
$row: the revision row for this line
$s: the string representing this parsed line
2010-01-07 01:21:02 +00:00
$classes: array containing the <li> element classes
2007-03-25 23:20:48 +00:00
2009-05-28 17:05:09 +00:00
'PageHistoryPager::getQueryInfo': when a history pager query parameter set
is constructed
2008-05-23 16:55:52 +00:00
$pager: the pager
$queryInfo: the query parameters
2005-12-25 11:04:40 +00:00
'PageRenderingHash': alter the parser cache option hash key
2009-05-28 17:05:09 +00:00
A parser extension which depends on user options should install
this hook and append its values to the key.
2005-12-25 11:04:40 +00:00
$hash: reference to a hash key string which can be modified
2007-12-03 19:47:11 +00:00
'ParserAfterStrip': Same as ParserBeforeStrip
'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2009-06-18 02:13:42 +00:00
$parser: Parser object being used
2007-12-03 19:47:11 +00:00
$text: text that'll be returned
'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
$parser: Parser object
$text: text to parse
$stripState: StripState instance being used
2009-05-28 17:05:09 +00:00
'ParserBeforeStrip': Called at start of parsing time
(no more strip, deprecated ?)
2007-12-03 19:47:11 +00:00
$parser: parser object
$text: text being parsed
$stripState: stripState used (object)
'ParserBeforeTidy': called before tidy and custom tags replacements
2009-06-18 02:13:42 +00:00
$parser: Parser object being used
2007-12-03 19:47:11 +00:00
$text: actual text
'ParserClearState': called at the end of Parser::clearState()
$parser: Parser object being cleared
2008-03-01 20:39:45 +00:00
'ParserFirstCallInit': called when the parser initialises for the first time
&$parser: Parser object being cleared
2008-02-10 11:39:39 +00:00
2009-05-28 17:05:09 +00:00
'ParserGetVariableValueSwitch': called when the parser need the value of a
custom magic word
2007-12-03 19:47:11 +00:00
$parser: Parser object
2009-05-28 17:05:09 +00:00
$varCache: array to store the value in case of multiples calls of the
same magic word
2007-12-03 19:47:11 +00:00
$index: index (string) of the magic
$ret: value of the magic word (the hook should set it)
2009-09-07 19:29:55 +00:00
$frame: PPFrame object to use for expanding any template variables
2007-12-03 19:47:11 +00:00
2009-05-28 17:05:09 +00:00
'ParserGetVariableValueTs': use this to change the value of the time for the
{{LOCAL...}} magic word
2007-12-03 19:47:11 +00:00
$parser: Parser object
$time: actual time (timestamp)
2009-05-28 17:05:09 +00:00
'ParserGetVariableValueVarCache': use this to change the value of the
variable cache or return false to not use it
2007-12-03 19:47:11 +00:00
$parser: Parser object
$varCache: varaiable cache (array)
2009-05-28 17:05:09 +00:00
'ParserLimitReport': called at the end of Parser:parse() when the parser will
include comments about size of the text parsed
2007-12-03 19:47:11 +00:00
$parser: Parser object
$limitReport: text that will be included (without comment tags)
2009-05-28 17:05:09 +00:00
'ParserMakeImageParams': Called before the parser make an image link, use this
to modify the parameters of the image.
2008-02-29 19:58:50 +00:00
$title: title object representing the file
$file: file object that will be used to create the image
&$params: 2-D array of parameters
2011-07-20 17:08:37 +00:00
'ParserSectionCreate': Called each time the parser creates a document section
from wikitext. Use this to apply per-section modifications to HTML (like
wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
can begin in one section and end in another. Make sure your code can handle
that case gracefully. See the EditSectionClearerLink extension for an
example.
2011-08-09 13:30:01 +00:00
$parser: the calling Parser instance
2011-07-20 17:08:37 +00:00
$section: the section number, zero-based, but section 0 is usually empty
&$sectionContent: ref to the content of the section. modify this.
$showEditLinks: boolean describing whether this section has an edit link
2009-05-28 17:05:09 +00:00
'ParserTestParser': called when creating a new instance of Parser in
maintenance/parserTests.inc
2007-12-03 19:47:11 +00:00
$parser: Parser object created
2007-02-09 05:37:44 +00:00
'ParserTestTables': alter the list of tables to duplicate when parser tests
are run. Use when page save hooks require the presence of custom tables
to ensure that tests continue to run properly.
&$tables: array of table names
2006-05-08 22:20:55 +00:00
'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
my talk page, my contributions" etc).
&$personal_urls: Array of link specifiers (see SkinTemplate.php)
2006-05-17 07:02:06 +00:00
&$title: Title object representing the current page
2006-05-08 22:20:55 +00:00
2006-12-22 20:21:14 +00:00
'PingLimiter': Allows extensions to override the results of User::pingLimiter()
&$user : User performing the action
$action : Action being performed
&$result : Whether or not the action should be prevented
Change $result and return false to give a definitive answer, otherwise
the built-in rate limiting checks are used, if enabled.
2011-10-27 23:55:29 +00:00
'PlaceNewSection': Override placement of new sections.
$wikipage : WikiPage object
$oldtext : the text of the article before editing
$subject : subject of the new section
&$text : text of the new section
Return false and put the merged text into $text to override the default behavior.
2011-10-31 12:36:51 +00:00
'PreferencesGetLegend': Override the text used for the <legend> of a preferences section
$key: the section name
&$legend: the legend text. Defaults to wfMsg( "prefs-$key" ) but may be overridden
2008-01-30 01:07:49 +00:00
'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
AJAX search suggestions. Put results into &$results outparam and return false.
2008-04-15 23:06:28 +00:00
$ns : array of int namespace keys to search in
2008-01-30 01:07:49 +00:00
$search : search term (not guaranteed to be conveniently normalized)
$limit : maximum number of results to return
&$results : out param: array of page names (strings)
2007-12-03 19:47:11 +00:00
'PrefsEmailAudit': called when user changes his email address
$user: User (object) changing his email address
$oldaddr: old email address (string)
$newaddr: new email address (string)
'PrefsPasswordAudit': called when user changes his password
$user: User (object) changing his passoword
$newPass: new password
$error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2009-10-02 18:46:19 +00:00
'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
$article: the title being (un)protected
$output: a string of the form HTML so far
'ProtectionForm::save': called when a protection form is submitted
$article: the title being (un)protected
$errorMsg: an html message string of an error
2009-10-02 18:47:38 +00:00
'ProtectionForm::showLogExtract': called after the protection log extract is shown
$article: the page the form is shown for
$out: OutputPage object
2007-01-11 14:50:34 +00:00
'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
&$obj: RawPage object
&$text: The text that's going to be the output
2011-01-09 11:44:52 +00:00
'RecentChange_save': called at the end of RecentChange::save()
2007-12-03 19:47:11 +00:00
$recentChange: RecentChange object
2011-02-12 17:15:24 +00:00
'ResourceLoaderGetConfigVars': called at the end of
2011-01-09 11:44:52 +00:00
ResourceLoaderStartUpModule::getConfig(). Use this to export static
configuration variables to JavaScript. Things that depend on the current
page/request state must be added through MakeGlobalVariablesScript instead.
&$vars: array( variable name => value )
2011-10-08 09:07:02 +00:00
'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
to add modules to the startup module. This hook should be used sparingly since any module added here
will be loaded on all pages. This hook is useful if you want to make code available to module loader
scripts.
'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
loader request or generating HTML output.
&$resourceLoader: ResourceLoader object
2008-04-15 15:38:08 +00:00
'RevisionInsertComplete': called after a revision is inserted into the DB
2008-07-10 18:04:32 +00:00
&$revision: the Revision
$data: the data stored in old_text. The meaning depends on $flags: if external
is set, it's the URL of the revision text in external storage; otherwise,
it's the revision text itself. In either case, if gzip is set, the revision
text is gzipped.
$flags: a comma-delimited list of strings representing the options used. May
include: utf8 (this will always be set for new revisions); gzip; external.
2008-04-15 15:38:08 +00:00
2007-04-10 02:18:42 +00:00
'SearchUpdate': Prior to search update completion
$id : Page id
$namespace : Page namespace
$title : Page title
$text : Current text being indexed
2010-01-16 23:27:55 +00:00
'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
$allSearchTerms : Array of the search terms in all content languages
2010-01-27 14:39:03 +00:00
&$titleResult : Outparam; the value to return. A Title object or null.
2010-01-16 23:27:55 +00:00
'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
2008-01-31 20:51:42 +00:00
$term : Search term string
&$title : Outparam; set to $title object and return false for a match
2010-01-16 23:27:55 +00:00
'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
$term : Search term string
2010-01-27 14:39:03 +00:00
&$title : Current Title object that is being returned (null if none found).
2010-01-16 23:27:55 +00:00
'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
$searchEngine : The SearchEngine object. Users of this hooks will be interested
in the $searchEngine->namespaces array.
$query : Original query.
&$parsed : Resultant query with the prefixes stripped.
'SearchableNamespaces': An option to modify which namespaces are searchable.
&$arr : Array of namespaces ($nsId => $name) which will be used.
2008-12-11 11:50:45 +00:00
'SetupAfterCache': Called in Setup.php, after cache objects are set
2009-09-14 18:10:13 +00:00
'ShowMissingArticle': Called when generating the output for a non-existent page
$article: The article object corresponding to the page
2007-08-28 21:53:50 +00:00
'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
$text: Text being shown
$title: Title of the custom script/stylesheet page
$output: Current OutputPage object
2009-08-14 16:06:11 +00:00
'ShowSearchHitTitle': Customise display of search hit title/link.
&$title: Title to link to
&$text: Text to use for the link
$result: The search result
$terms: The search terms entered
$page: The SpecialSearch object.
2006-06-04 16:55:19 +00:00
'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
&$siteNotice: HTML returned as the sitenotice
2011-02-12 21:24:05 +00:00
$skin: Skin object
2006-06-04 16:55:19 +00:00
Return true to allow the normal method of notice selection/rendering to work,
or change the value of $siteNotice and return false to alter it.
'SiteNoticeAfter': After the sitenotice/anonnotice is composed
&$siteNotice: HTML sitenotice
2011-02-12 21:24:05 +00:00
$skin: Skin object
2006-06-04 16:55:19 +00:00
Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
2007-08-23 22:34:12 +00:00
'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
$skin: Skin object
&$text: bottomScripts Text
Append to $text to add additional text/scripts after the stock bottom scripts.
2008-08-08 15:53:49 +00:00
'SkinAfterContent': Allows extensions to add text after the page content and
article metadata.
&$data: (string) Text to be printed out directly (without parsing)
2010-08-24 01:31:28 +00:00
$skin: Skin object
2008-08-08 15:53:49 +00:00
This hook should work in all skins. Just set the &$data variable to the text
you're going to add.
2008-08-01 14:40:05 +00:00
'SkinBuildSidebar': At the end of Skin::buildSidebar()
$skin: Skin object
&$bar: Sidebar contents
Modify $bar to add or modify sidebar portlets.
2009-06-24 16:49:28 +00:00
'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
$title: displayed page title
$type: 'normal' or 'history' for old/diff views
&$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
&$link: overridable HTML link to be passed into the message as $1
2010-07-21 16:01:10 +00:00
&$forContent: overridable flag if copyright footer is shown in content language.
2009-06-24 16:49:28 +00:00
2010-11-10 08:18:21 +00:00
'SkinGetPoweredBy'
2010-11-12 12:16:48 +00:00
&$text: additional 'powered by' icons in HTML.
Note: Modern skin does not use the MediaWiki icon but plain text instead
2010-11-14 19:45:55 +00:00
$skin: Skin object
2010-11-10 08:18:21 +00:00
2008-01-29 15:05:48 +00:00
'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
&$subpages: Subpage links HTML
2010-09-26 16:37:00 +00:00
$skin: Skin object
2011-03-03 11:00:08 +00:00
$out: OutputPage object
2009-05-28 17:05:09 +00:00
If false is returned $subpages will be used instead of the HTML
subPageSubtitle() generates.
If true is returned, $subpages will be ignored and the rest of
subPageSubtitle() will run.
2008-01-29 15:05:48 +00:00
2009-05-28 17:05:09 +00:00
'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
"permanent link" tab
2007-12-03 19:47:11 +00:00
$sktemplate: SkinTemplate object
$nav_urls: array of tabs
2010-12-31 17:48:07 +00:00
Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
2010-12-31 23:30:00 +00:00
'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
2010-12-31 17:48:07 +00:00
'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
2009-07-08 17:59:08 +00:00
&$sktemplate: SkinTemplate object
2009-07-06 21:22:40 +00:00
&$links: Structured navigation links
This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
2009-05-28 17:05:09 +00:00
'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
starts page output
2007-01-10 15:23:32 +00:00
&$sktemplate: SkinTemplate object
&$tpl: Template engine object
2007-12-03 19:47:11 +00:00
'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
$sktemplate: SkinTemplate object
$res: set to true to prevent active tabs
2007-11-06 01:16:25 +00:00
'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2009-05-28 17:05:09 +00:00
You can either create your own array, or alter the parameters for
the normal one.
2009-11-17 20:52:04 +00:00
&$sktemplate: The SkinTemplate instance.
$title: Title instance for the page.
$message: Visible label of tab.
$selected: Whether this is a selected tab.
2007-11-06 01:16:25 +00:00
$checkEdit: Whether or not the action=edit query should be added if appropriate.
2009-11-17 20:52:04 +00:00
&$classes: Array of CSS classes to apply.
&$query: Query string to add to link.
&$text: Link text.
&$result: Complete assoc. array if you want to return true.
2007-11-06 01:16:25 +00:00
2009-05-28 17:05:09 +00:00
'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
been rendered (useful for adding more)
2011-01-13 22:06:48 +00:00
$sk: The QuickTemplate based skin template running the hook.
2011-10-09 19:42:45 +00:00
$dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
extensions that add support for BaseTemplateToolbox should watch for this dummy
parameter with "$dummy=false" in their code and return without echoing any html
to avoid creating duplicate toolbox items.
2008-04-30 10:17:51 +00:00
2009-05-28 17:05:09 +00:00
'SoftwareInfo': Called by Special:Version for returning information about
the software
$software: The array of software in format 'name' => 'version'.
See SpecialVersion::softwareInformation()
2009-04-20 13:05:15 +00:00
2007-07-16 11:30:27 +00:00
'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
$id: User identifier
2007-07-16 07:11:25 +00:00
2009-05-28 17:05:09 +00:00
'SpecialListusersDefaultQuery': called right before the end of
UsersPager::getDefaultQuery()
2008-03-02 14:14:43 +00:00
$pager: The UsersPager instance
$query: The query array to be returned
2009-05-28 17:05:09 +00:00
'SpecialListusersFormatRow': called right before the end of
UsersPager::formatRow()
2008-03-02 14:14:43 +00:00
$item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
$row: Database row object
2009-05-28 17:05:09 +00:00
'SpecialListusersHeader': called before closing the <fieldset> in
UsersPager::getPageHeader()
2008-03-02 14:14:43 +00:00
$pager: The UsersPager instance
$out: The header HTML
2009-05-28 17:05:09 +00:00
'SpecialListusersHeaderForm': called before adding the submit button in
UsersPager::getPageHeader()
2008-03-02 14:14:43 +00:00
$pager: The UsersPager instance
$out: The header HTML
2009-05-28 17:05:09 +00:00
'SpecialListusersQueryInfo': called right before the end of
UsersPager::getQueryInfo()
2008-03-02 14:14:43 +00:00
$pager: The UsersPager instance
$query: The query array to be returned
2007-12-03 19:47:11 +00:00
'SpecialMovepageAfterMove': called after moving a page
$movePage: MovePageForm object
$oldTitle: old title (object)
$newTitle: new title (object)
2010-04-24 11:05:15 +00:00
'SpecialNewpagesConditions': called when building sql query for Special:NewPages
&$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2010-04-24 11:12:07 +00:00
$opts: FormOptions object containing special page options
2010-04-24 11:05:15 +00:00
&$conds: array of WHERE conditionals for query
2011-05-23 04:28:58 +00:00
&tables: array of tables to be queried
&$fields: array of columns to select
&$join_conds: join conditions for the tables
'SpecialNewPagesFilters': called after building form options at NewPages
$special: the special page object
&$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
2010-04-24 11:05:15 +00:00
2009-05-28 17:05:09 +00:00
'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
hook to remove a core special page
2007-12-03 19:47:11 +00:00
$list: list (array) of core special pages
2011-06-13 14:55:03 +00:00
'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
$users: array of User objects
$data: array of data submitted by the user
&$error: string, error code (message name) used to describe to error (out paramater).
The hook needs to return false when setting this, otherwise it will have no effect.
2009-08-17 15:23:51 +00:00
'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
use this to change some selection criteria or substitute a different title
&$randstr: The random number from wfRandom()
&$isRedir: Boolean, whether to select a redirect or non-redirect
&$namespaces: An array of namespace indexes to get the title from
&$extra: An array of extra SQL statements
&$title: If the hook returns false, a Title object to use instead of the
result from the normal query
2011-05-23 04:28:58 +00:00
'SpecialRecentChangesFilters': called after building form options at RecentChanges
$special: the special page object
&$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
2009-05-28 17:05:09 +00:00
'SpecialRecentChangesPanel': called when building form options in
SpecialRecentChanges
2008-06-17 08:24:00 +00:00
&$extraOpts: array of added items, to which can be added
$opts: FormOptions for this request
2009-05-28 17:05:09 +00:00
'SpecialRecentChangesQuery': called when building sql query for
2010-08-06 13:07:46 +00:00
SpecialRecentChanges and SpecialRecentChangesLinked
2008-12-21 21:31:06 +00:00
&$conds: array of WHERE conditionals for query
2008-06-17 08:24:00 +00:00
&$tables: array of tables to be queried
&$join_conds: join conditions for the tables
$opts: FormOptions for this request
2010-01-29 17:27:30 +00:00
&$query_options: array of options for the database request
2011-05-23 04:28:58 +00:00
&$select: Array of columns to select
2008-06-17 08:24:00 +00:00
2011-09-15 16:26:35 +00:00
'SpecialSearchCreateLink': called when making the message to create a page or
go to the existing page
$t: title object searched for
&$params: an array of the default message name and page title (as parameter)
2010-12-12 18:57:10 +00:00
'SpecialSearchGo': called when user clicked the "Go"
2010-12-12 18:17:33 +00:00
&$title: title object generated from the text entered by the user
2010-12-13 20:00:43 +00:00
&$term: the search term entered by the user
2010-04-16 10:19:50 +00:00
2009-05-28 17:05:09 +00:00
'SpecialSearchNogomatch': called when user clicked the "Go" button but the
target doesn't exist
2010-12-12 18:17:33 +00:00
&$title: title object generated from the text entered by the user
2007-12-03 19:47:11 +00:00
2011-09-15 16:26:35 +00:00
'SpecialSearchPowerBox': the equivalent of SpecialSearchProfileForm for
the advanced form, a.k.a. power search box
&$showSections: an array to add values with more options to
$term: the search term (not a title object)
$opts: an array of hidden options (containing 'redirs' and 'profile')
2009-09-08 11:50:31 +00:00
'SpecialSearchProfiles': allows modification of search profiles
&$profiles: profiles, which can be modified.
2011-04-22 16:13:58 +00:00
'SpecialSearchProfileForm': allows modification of search profile forms
$search: special page object
&$form: String: form html
$profile: String: current search profile
$term: String: search term
$opts: Array: key => value of hidden options for inclusion in custom forms
'SpecialSearchSetupEngine': allows passing custom data to search engine
$search: special page object
$profile: String: current search profile
$engine: the search engine
2009-05-28 17:05:09 +00:00
'SpecialSearchResults': called before search result display when there
are matches
2008-03-21 22:36:34 +00:00
$term: string of search term
2008-06-05 18:13:16 +00:00
&$titleMatches: empty or SearchResultSet object
&$textMatches: empty or SearchResultSet object
2008-03-21 22:36:34 +00:00
2009-05-28 17:05:09 +00:00
'SpecialSearchNoResults': called before search result display when there are
no matches
2008-03-21 22:36:34 +00:00
$term: string of search term
2009-08-06 13:40:13 +00:00
'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
&$extraStats: Array to save the new stats
( $extraStats['<name of statistic>'] => <value>; )
2009-07-19 20:03:13 +00:00
'SpecialUploadComplete': Called after successfully uploading a file from
Special:Upload
2009-10-23 20:05:31 +00:00
$form: The SpecialUpload object
2009-07-19 20:03:13 +00:00
2009-05-28 17:05:09 +00:00
'SpecialVersionExtensionTypes': called when generating the extensions credits,
use this to change the tables headers
2007-12-03 19:47:11 +00:00
$extTypes: associative array of extensions types
2011-05-23 04:28:58 +00:00
'SpecialWatchlistFilters': called after building form options at Watchlist
$special: the special page object
&$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
2008-12-21 21:31:06 +00:00
'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
&$conds: array of WHERE conditionals for query
&$tables: array of tables to be queried
&$join_conds: join conditions for the tables
&$fields: array of query fields
2011-09-19 23:14:52 +00:00
'TestCanonicalRedirect': called when about to force a redirect to a canonical URL for a title when we have no other parameters on the URL. Gives a chance for extensions that alter page view behavior radically to abort that redirect or handle it manually.
$request: WebRequest
$title: Title of the currently found title obj
$output: OutputPage object
2009-05-28 17:05:09 +00:00
'TitleArrayFromResult': called when creating an TitleArray object from a
database result
2008-07-29 14:53:10 +00:00
&$titleArray: set this to an object to override the default object returned
$res: database result used to create the object
2009-11-09 12:05:30 +00:00
'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
that can be applied.
$title: The title in question.
&$types: The types of protection available.
2011-08-02 15:40:27 +00:00
'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page
$title: Title object that is being checked
$result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page. Hooks may change this value to override the return value of Title::isCssOrJsPage()
2011-08-31 12:18:02 +00:00
'TitleIsMovable': Called when determining if it is possible to move a page.
Note that this hook is not called for interwiki pages or pages in immovable namespaces: for these, isMovable() always returns false.
2011-08-30 11:21:24 +00:00
$title: Title object that is being checked
$result: Boolean; whether MediaWiki currently thinks this page is movable. Hooks may change this value to override the return value of Title::isMovable()
2011-08-11 17:21:31 +00:00
'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
be handled by seperate handler (via ArticleViewCustom)
$title: Title object that is being checked
$result: Boolean; whether MediaWiki currently thinks this is a wikitext page. Hooks may change this value to override the return value of Title::isWikitextPage()
Changed the calling protocol for function wfRunHooks() in Hooks.php.
Previously, this function used variable arguments to allow
different hooks to pass different parameters. However, var args
silently convert reference-calling to value-calling. So a call
that used to work like this:
# old
wfRunHooks('SomeEvent', $param1, &$param2, $param3);
...now works like this:
# new
wfRunHooks('SomeEvent', array($param1, &$param2, $param3));
Hook functions can now change pass-by-reference parameters correctly
(e.g. $param2 in the above example).
All calls to wfRunHooks() were changed and tested, and the change
was documented in docs/hooks.doc. This change was originally checked
in on REL1_4 branch as a bugfix, but per vibber reverted and checked
in to HEAD instead.
2005-03-13 15:29:43 +00:00
'TitleMoveComplete': after moving an article (title)
$old: old title
$nt: new title
$user: user who did the move
2005-06-01 02:31:45 +00:00
$pageid: database ID of the page that's been moved
$redirid: database ID of the created redirect
Changed the calling protocol for function wfRunHooks() in Hooks.php.
Previously, this function used variable arguments to allow
different hooks to pass different parameters. However, var args
silently convert reference-calling to value-calling. So a call
that used to work like this:
# old
wfRunHooks('SomeEvent', $param1, &$param2, $param3);
...now works like this:
# new
wfRunHooks('SomeEvent', array($param1, &$param2, $param3));
Hook functions can now change pass-by-reference parameters correctly
(e.g. $param2 in the above example).
All calls to wfRunHooks() were changed and tested, and the change
was documented in docs/hooks.doc. This change was originally checked
in on REL1_4 branch as a bugfix, but per vibber reverted and checked
in to HEAD instead.
2005-03-13 15:29:43 +00:00
2011-05-16 13:30:32 +00:00
'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
PageArchive object has been created but before any further processing is done.
&$archive: PageArchive object
$title: Title object of the page that we're viewing
'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
PageArchive object has been created but before any further processing is done.
&$archive: PageArchive object
$title: Title object of the page that we're viewing
'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
the site is not in read-only mode, that the Title object is not null and after
a PageArchive object has been constructed but before performing any further
processing.
&$archive: PageArchive object
$title: Title object of the page that we're about to undelete
2007-12-03 19:47:11 +00:00
'UndeleteShowRevision': called when showing a revision in Special:Undelete
$title: title object related to the revision
$rev: revision (object) that will be viewed
2004-11-28 07:06:25 +00:00
'UnknownAction': An unknown "action" has occured (useful for defining
your own actions)
$action: action name
$article: article "acted on"
2010-06-28 18:17:47 +00:00
'UnitTestsList': Called when building a list of files with PHPUnit tests
&$files: list of files
2004-11-30 05:45:56 +00:00
'UnwatchArticle': before a watch is removed from an article
$user: user watching
$article: article object to be removed
'UnwatchArticle': after a watch is removed from an article
$user: user that was watching
$article: article object removed
2007-08-28 21:53:50 +00:00
'UnwatchArticleComplete': after a watch is removed from an article
$user: user that watched
$article: article object that was watched
2009-12-21 19:57:43 +00:00
'UploadForm:initial': before the upload form is generated
$form: UploadForm object
You might set the member-variables $uploadFormTextTop and
$uploadFormTextAfterSummary to inject text (HTML) either before
or after the editform.
2010-11-08 21:07:10 +00:00
'UploadForm:BeforeProcessing': at the beginning of processUpload()
2009-12-21 19:57:43 +00:00
$form: UploadForm object
Lets you poke at member variables like $mUploadDescription before the
file is saved.
2010-11-08 21:07:10 +00:00
Do not use this hook to break upload processing. This will return the user to
a blank form with no error message; use UploadVerification and
UploadVerifyFile instead
2009-12-21 19:57:43 +00:00
2009-10-23 20:05:31 +00:00
'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
2009-11-17 20:52:04 +00:00
$type: (string) the requested upload type
2009-10-23 20:05:31 +00:00
&$className: the class name of the Upload instance to be created
2006-11-25 13:51:50 +00:00
2009-10-23 20:05:31 +00:00
'UploadComplete': when Upload completes an upload
&$upload: an UploadBase child instance
'UploadFormInitDescriptor': after the descriptor for the upload form as been
2009-11-17 20:52:04 +00:00
assembled
$descriptor: (array) the HTMLForm descriptor
2009-10-23 20:05:31 +00:00
'UploadFormSourceDescriptors': after the standard source inputs have been
added to the descriptor
2009-11-17 20:52:04 +00:00
$descriptor: (array) the HTMLForm descriptor
2006-11-29 18:21:56 +00:00
2010-08-30 12:10:02 +00:00
'UploadVerification': additional chances to reject an uploaded file. Consider
using UploadVerifyFile instead.
2005-09-06 04:53:59 +00:00
string $saveName: destination file name
string $tempName: filesystem path to the temporary file for checks
2009-11-13 16:08:17 +00:00
string &$error: output: message key for message to show if upload canceled
by returning false. May also be an array, where the first element
is the message key and the remaining elements are used as parameters to
the message.
2005-09-06 04:53:59 +00:00
2010-08-30 12:10:02 +00:00
'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
in most cases over UploadVerification.
object $upload: an instance of UploadBase, with all info about the upload
2010-08-31 11:01:00 +00:00
string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
2010-08-30 12:10:02 +00:00
will typically only apply for specific mime types.
2010-08-31 11:01:00 +00:00
object &$error: output: true if the file is valid. Otherwise, an indexed array
2010-08-30 12:10:02 +00:00
representing the problem with the file, where the first element
is the message key and the remaining elements are used as parameters to
the message.
2006-04-13 18:29:18 +00:00
'UploadComplete': Upon completion of a file upload
2009-07-21 11:48:52 +00:00
$uploadBase: UploadBase (or subclass) object. File can be accessed by
$uploadBase->getLocalFile().
2006-04-13 18:29:18 +00:00
2009-05-28 17:05:09 +00:00
'User::mailPasswordInternal': before creation and mailing of a user's new
temporary password
2008-08-14 00:18:21 +00:00
$user: the user who sent the message out
$ip: IP of the user who sent the message out
$u: the account whose new password will be set
2011-03-16 23:13:38 +00:00
'UserAddGroup': called when adding a group; return false to override
stock group addition.
$user: the user object that is to have a group added
2011-03-17 19:22:10 +00:00
&$group: the group to add, can be modified
2011-03-16 23:13:38 +00:00
2009-05-28 17:05:09 +00:00
'UserArrayFromResult': called when creating an UserArray object from a
database result
2008-07-29 14:53:10 +00:00
&$userArray: set this to an object to override the default object returned
$res: database result used to create the object
2007-11-30 17:28:24 +00:00
'userCan': To interrupt/advise the "user can do X to Y article" check.
2009-05-28 17:05:09 +00:00
If you want to display an error message, try getUserPermissionsErrors.
2006-02-05 18:53:37 +00:00
$title: Title object being checked against
$user : Current user object
$action: Action being checked
2006-04-04 08:46:06 +00:00
$result: Pointer to result returned if hook returns false. If null is returned,
2009-05-28 17:05:09 +00:00
userCan checks are continued by internal code.
2006-02-05 18:53:37 +00:00
2008-01-29 00:31:26 +00:00
'UserCanSendEmail': To override User::canSendEmail() permission check
$user: User (object) whose permission is being checked
&$canSend: bool set on input, can override on output
2009-05-28 17:05:09 +00:00
'UserClearNewTalkNotification': called when clearing the
"You have new messages!" message, return false to not delete it
2007-12-03 19:47:11 +00:00
$user: User (object) that'll clear the message
2009-05-28 17:05:09 +00:00
'UserComparePasswords': called when checking passwords, return false to
override the default password checks
2008-12-19 23:18:44 +00:00
&$hash: String of the password hash (from the database)
&$password: String of the plaintext password the user entered
2009-05-28 17:05:09 +00:00
&$userId: Integer of the user's ID or Boolean false if the user ID was not
supplied
&$result: If the hook returns false, this Boolean value will be checked to
determine if the password was valid
2008-12-19 23:18:44 +00:00
2006-01-29 07:35:28 +00:00
'UserCreateForm': change to manipulate the login form
2009-09-26 00:49:32 +00:00
$template: SimpleTemplate instance for the form
2006-01-29 07:35:28 +00:00
2009-05-28 17:05:09 +00:00
'UserCryptPassword': called when hashing a password, return false to implement
your own hashing method
2008-12-19 23:18:44 +00:00
&$password: String of the plaintext password to encrypt
&$salt: String of the password salt or Boolean false if no salt is provided
2009-05-28 17:05:09 +00:00
&$wgPasswordSalt: Boolean of whether the salt is used in the default
hashing method
2008-12-19 23:18:44 +00:00
&$hash: If the hook returns false, this String will be used as the hash
2007-12-03 19:47:11 +00:00
'UserEffectiveGroups': Called in User::getEffectiveGroups()
$user: User to get groups for
&$groups: Current effective groups
2008-05-09 16:22:33 +00:00
'UserGetAllRights': after calculating a list of all available rights
&$rights: Array of rights, which may be added to.
2011-09-17 02:42:34 +00:00
'UserGetDefaultOptions': after fetching the core default, this hook is ran
right before returning the options to the caller.
&$defaultOptions: Array of preference keys and their default values.
2008-04-15 15:37:02 +00:00
'UserGetEmail': called when getting an user email address
$user: User object
&$email: email, change this to override local email
2009-05-28 17:05:09 +00:00
'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
email authentification
2008-04-15 15:37:02 +00:00
$user: User object
2009-05-28 17:05:09 +00:00
&$timestamp: timestamp, change this to override local email authentification
timestamp
2008-04-15 15:37:02 +00:00
'UserGetImplicitGroups': Called in User::getImplicitGroups()
&$groups: List of implicit (automatically-assigned) groups
2011-03-06 21:05:18 +00:00
'UserGetLanguageObject': Called when getting user's interface language object
$user: User object
&$code: Langauge code that will be used to create the object
2008-08-07 16:12:25 +00:00
'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
2009-07-21 11:48:52 +00:00
&$reservedUsernames: $wgReservedUsernames
2008-08-07 16:12:25 +00:00
2008-04-15 15:37:02 +00:00
'UserGetRights': Called in User::getRights()
$user: User to get rights for
&$rights: Current rights
2009-10-07 14:30:12 +00:00
'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
exemptions).
$user: User in question
$title: Title of the page in question
&$blocked: Out-param, whether or not the user is blocked from that page.
&$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
own user talk pages.
2009-01-29 19:48:56 +00:00
'UserIsBlockedGlobally': Check if user is blocked on all wikis.
&$user: User object
$ip: User's IP address
&$blocked: Whether the user is blocked, to be modified by the hook
2009-05-28 17:05:09 +00:00
'UserLoadAfterLoadFromSession': called to authenticate users on
external/environmental means; occurs after session is loaded
2009-04-24 01:31:17 +00:00
$user: user object being loaded
2008-06-11 11:07:34 +00:00
'UserLoadDefaults': called when loading a default user
$user: user object
$name: user name
2009-01-16 23:34:38 +00:00
'UserLoadFromDatabase': called when loading a user from the database
$user: user object
&$s: database query object
2009-05-28 17:05:09 +00:00
'UserLoadFromSession': called to authenticate users on external/environmental
means; occurs before session is loaded
2008-10-13 19:00:54 +00:00
$user: user object being loaded
2009-05-28 17:05:09 +00:00
&$result: set this to a boolean value to abort the normal authentification
process
2008-10-13 19:00:54 +00:00
2009-05-28 17:05:09 +00:00
'UserLoadOptions': when user options/preferences are being loaded from
the database.
2009-04-24 01:31:17 +00:00
$user: User object
&$options: Options, can be modified.
2008-05-14 12:45:16 +00:00
2004-11-27 23:10:05 +00:00
'UserLoginComplete': after a user has logged in
$user: the user object that was created on login
2008-09-08 22:15:44 +00:00
$inject_html: Any HTML to inject after the "logged in" message.
2009-06-18 02:13:42 +00:00
2006-01-29 07:35:28 +00:00
'UserLoginForm': change to manipulate the login form
2009-09-26 00:49:32 +00:00
$template: SimpleTemplate instance for the form
2006-01-29 07:35:28 +00:00
2004-11-27 23:10:05 +00:00
'UserLogout': before a user logs out
$user: the user object that is about to be logged out
2009-06-18 02:13:42 +00:00
2004-11-27 23:10:05 +00:00
'UserLogoutComplete': after a user has logged out
$user: the user object _after_ logout (won't have name, ID, etc.)
2008-04-09 12:44:53 +00:00
$inject_html: Any HTML to inject after the "logged out" message.
2008-05-27 19:59:15 +00:00
$oldName: name of the user before logout (string)
2006-03-29 02:31:15 +00:00
2011-03-16 23:13:38 +00:00
'UserRemoveGroup': called when removing a group; return false to override
stock group removal.
$user: the user object that is to have a group removed
2011-03-17 19:22:10 +00:00
&$group: the group to be removed, can be modified
2011-03-16 23:13:38 +00:00
2006-03-29 02:31:15 +00:00
'UserRights': After a user's group memberships are changed
$user : User object that was changed
$add : Array of strings corresponding to groups added
$remove: Array of strings corresponding to groups removed
2007-07-21 01:00:42 +00:00
2009-05-28 17:05:09 +00:00
'UserRetrieveNewTalks': called when retrieving "You have new messages!"
message(s)
2007-12-03 19:47:11 +00:00
$user: user retrieving new talks messages
$talks: array of new talks page(s)
2008-04-15 15:37:02 +00:00
'UserSaveSettings': called when saving user settings
$user: User object
2009-04-24 01:31:17 +00:00
'UserSaveOptions': Called just before saving user preferences/options.
$user: User object
&$options: Options, modifiable
2008-06-11 11:07:34 +00:00
'UserSetCookies': called when setting user cookies
$user: User object
&$session: session array, will be added to $_SESSION
&$cookies: cookies array mapping cookie name to its value
2008-04-15 15:37:02 +00:00
'UserSetEmail': called when changing user email address
$user: User object
&$email: new email, change this to override new email address
2009-05-28 17:05:09 +00:00
'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
of email authentification
2008-04-15 15:37:02 +00:00
$user: User object
2009-05-28 17:05:09 +00:00
&$timestamp: new timestamp, change this to override local email
authentification timestamp
2008-04-15 15:37:02 +00:00
2010-12-22 14:16:25 +00:00
'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
used to alter the SQL query which gets the list of wanted pages
2009-01-19 15:35:15 +00:00
&$wantedPages: WantedPagesPage object
2010-12-22 14:16:25 +00:00
&$query: query array, see QueryPage::getQueryInfo() for format documentation
2009-01-19 15:35:15 +00:00
2007-08-28 21:53:50 +00:00
'WatchArticle': before a watch is added to an article
$user: user that will watch
$article: article object to be watched
2005-07-29 15:08:57 +00:00
2007-08-28 21:53:50 +00:00
'WatchArticleComplete': after a watch is added to an article
$user: user that watched
$article: article object watched
2007-07-02 23:22:39 +00:00
2010-05-08 13:23:11 +00:00
'WatchlistEditorBuildRemoveLine': when building remove lines in
Special:Watchlist/edit
&$tools: array of extra links
$title: Title object
$redirect: whether the page is a redirect
$skin: Skin object
2011-08-12 19:23:43 +00:00
'WebRequestGetPathInfoRequestURI': while extracting path info from REQUEST_URI.
Allows an extension to extend the extraction of titles from paths.
Implementing hooks should follow the pattern used in core:
* Use the `$matches = WebRequest::extractTitle` pattern
* Ensure that you test `if ( !$matches ) {` before you try extracting a title
from the path so that you don't override an already found match.
$path: The request path to extract a title from.
&$matches: The array to apply matches to.
2009-05-28 17:05:09 +00:00
'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
dumps
2009-04-19 15:12:15 +00:00
One, and only one hook should set this, and return false.
&$tables: Database tables to use in the SELECT query
&$opts: Options to use for the query
&$join: Join conditions
2011-10-02 17:36:19 +00:00
'wfShellMaintenanceCmd': Called when generating a shell-escaped command line
string to run a maintenance script.
&$script: MediaWiki maintenance script path
&$parameters: Array of arguments and options to the script
&$options: Associative array of options, may contain the 'php' and 'wrapper'
keys
2009-05-28 17:05:09 +00:00
'wgQueryPages': called when initialising $wgQueryPages, use this to add new
query pages to be updated with maintenance/updateSpecialPages.php
2007-12-03 19:47:11 +00:00
$query: $wgQueryPages itself
2007-01-21 16:46:36 +00:00
2009-07-27 17:57:51 +00:00
'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
metadata to be added.
$obj: The XmlDumpWriter object.
&$out: The output string.
$row: The database row for the page.
$title: The title of the page.
'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
metadata.
$obj: The XmlDumpWriter object.
&$out: The text being output.
$row: The database row for the revision.
$text: The revision text.
2011-04-16 01:23:15 +00:00
'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
additional tags to extract.
&$items: Array containing information on which items to extract. See XMPInfo for details on the format.
'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
used to post-process the results.
&$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
metadata tags returned (each tag is either a value, or an array of values).
2006-05-02 20:59:56 +00:00
More hooks might be available but undocumented, you can execute
2007-10-21 17:15:37 +00:00
./maintenance/findhooks.php to find hidden one.