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
2013-05-17 00:16:59 +00:00
require_once 'extensions/ReverseTitle.php';
2007-06-18 15:37:10 +00:00
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
2013-01-04 15:56:58 +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.
2011-04-05 01:18:40 +00:00
$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.
2013-01-04 15:56:58 +00:00
'AbortDiffCache': Can be used to cancel the caching of a diff.
2008-11-06 21:41:07 +00:00
&$diffEngine: DifferenceEngine object
2012-07-17 19:58:53 +00:00
'AbortEmailNotification': Can be used to cancel email notifications for an edit.
$editor: The User who made the change.
$title: The Title of the page that was edited.
2014-05-10 07:48:54 +00:00
$rc: The current RecentChange object.
2012-07-17 19:58:53 +00:00
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
2013-01-04 15:56:58 +00:00
'AbortMove': Allows to abort moving an article (title).
2007-12-08 18:30:00 +00:00
$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)
2012-08-20 14:55:28 +00:00
&$msg: out parameter: HTML to display on abort
2014-01-17 20:26:41 +00:00
&$status: out parameter: Status object to return, replaces the older $msg param (added in 1.23)
Create the object with Status::newFatal() to ensure proper API error messages
are returned when creating account through API clients.
2005-12-17 03:18:39 +00:00
2013-06-10 22:11:39 +00:00
'AbortTalkPageEmailNotification': Return false to cancel talk page email notification
$targetUser: the user whom to send talk page email notification
$title: the page title
2014-02-21 01:40:29 +00:00
'SendWatchlistEmailNotification': Return true to send watchlist email notification
$targetUser: the user whom to send watchlist email notification
$title: the page title
2014-05-11 10:02:21 +00:00
$enotif: EmailNotification object
2014-02-21 01:40:29 +00:00
2013-04-30 19:37:52 +00:00
'AbortChangePassword': Return false to cancel password change.
$user: the User object to which the password change is occuring
$mOldpass: the old password provided by the user
$newpass: the new password provided by the user
&$abortMsg: the message identifier for abort reason
2013-01-04 15:56:58 +00:00
'ActionBeforeFormDisplay': Before executing the HTMLForm object.
2011-06-13 14:55:03 +00:00
$name: name of the action
&$form: HTMLForm object
$article: Article object
2013-01-04 15:56:58 +00:00
'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
Allows to change the fields on the form that will be generated.
2011-06-13 14:55:03 +00:00
$name: name of the action
&$fields: HTMLForm descriptor array
$article: Article object
2013-01-04 15:56:58 +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
2014-01-10 23:16:40 +00:00
'AddNewAccountApiForm': Allow modifying internal login form when creating an account via API.
$apiModule: the ApiCreateAccount module calling
$loginForm: the LoginForm used
'AddNewAccountApiResult': Modify API output when creating a new account via API.
$apiModule: the ApiCreateAccount module calling
$loginForm: the LoginForm used
&$result: associative array for API result data
2014-05-25 06:23:02 +00:00
'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
before OutputPage::sendCacheControl() and final ob_end_flush() which
will send the buffered output to the client. This allows for last-minute
modification of the output within the buffer by using ob_get_clean().
$output: The OutputPage object where output() was called
2012-07-04 21:23:56 +00:00
2013-01-04 15:56:58 +00:00
'AfterImportPage': When a page import is completed.
2010-07-03 14:33:09 +00:00
$title: Title under which the revisions were imported
$origTitle: Title provided by the XML file
$revCount: Number of revisions in the XML file
2013-01-27 17:59:24 +00:00
$sRevCount: Number of successfully imported revisions
2010-07-03 14:33:09 +00:00
$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; ).
2013-01-04 15:56:58 +00:00
&$output: OutputPage object
2007-08-28 21:53:50 +00:00
2013-01-04 15:56:58 +00:00
'AlternateEdit': Before checking if a user can edit a page and before showing
the edit form ( EditPage::edit() ). This is triggered on &action=edit.
$editPage: the EditPage object
2007-05-19 21:45:07 +00:00
2013-01-04 15:56:58 +00:00
'AlternateEditPreview': Before generating the preview of the page when editing
2012-11-10 00:54:57 +00:00
( EditPage::getPreviewText() ).
2013-01-04 15:56:58 +00:00
$editPage: the EditPage object
2012-11-10 00:54:57 +00:00
&$content: the Content object for the text field from the edit page
&$previewHTML: Text to be placed into the page for the preview
&$parserOutput: the ParserOutput object for the preview
return false and set $previewHTML and $parserOutput to output custom page
preview HTML.
2013-01-04 15:56:58 +00:00
'AlternateUserMailer': Called before mail is sent so that mail could 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
2013-01-04 15:56:58 +00:00
'APIAfterExecute': After calling the execute() method of an API module. Use
this to extend core API modules.
2008-09-17 18:49:22 +00:00
&$module: Module object
2013-12-12 15:01:33 +00:00
'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
&$main: ApiMain object
2013-01-04 15:56:58 +00:00
'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
authenticate and authorize API clients before executing the module. Return
false and set a message to cancel the request.
2012-08-21 15:52:47 +00:00
$module: Module object
$user: Current user
2012-09-11 13:16:39 +00:00
&$message: API usage message to die with, as a message key or array
as accepted by ApiBase::dieUsageMsg.
2012-08-21 15:52:47 +00:00
2013-01-04 15:56:58 +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
2008-03-03 18:08:40 +00:00
$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
2013-01-04 15:56:58 +00:00
'APIGetAllowedParams': Use this hook to modify a module's parameters.
2011-11-28 15:33:28 +00:00
&$module: ApiBase Module object
2008-09-07 19:04:51 +00:00
&$params: Array of parameters
2013-02-08 20:39:40 +00:00
$flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
2008-09-07 19:04:51 +00:00
2013-01-04 15:56:58 +00:00
'APIGetDescription': Use this hook to modify a module's description.
2011-11-28 15:33:28 +00:00
&$module: ApiBase Module object
&$desc: Array of descriptions
2013-01-04 15:56:58 +00:00
'APIGetParamDescription': Use this hook to modify a module's parameter
2008-09-07 19:04:51 +00:00
descriptions.
2011-11-28 15:33:28 +00:00
&$module: ApiBase Module object
2008-09-07 19:04:51 +00:00
&$desc: Array of parameter descriptions
2013-01-27 17:59:24 +00:00
'APIGetResultProperties': Use this hook to modify the properties in a module's
2013-01-04 15:56:58 +00:00
result.
Added result properties to action=paraminfo
Added information about the properties of the results of API calls
to action=paraminfo, including information about "property groups":
what should the prop parameter be set to to get that property.
Uses the same format for types as parameters already do.
The output format of some modules doesn't fit this, so the result
properties for them weren't added, or only partially.
Partially implemented modules:
* expandtemplates:
parsetree is in its own tag
* protect, allusers, backlinks, deletedrevs, info, imageinfo,
logevents, querypage, recentchanges, revisions, searchinfo,
usercontribs, userinfo, users, watchlist, upload:
response with partially complex structure
Not implemented modules:
* feedcontributions, feedwatchlist, opensearch, rds:
non-standard reponse
* help:
error is normal response; not very useful for automated tools anyway
* paraminfo, parse, pageprops, siteinfo, userrights:
response with complex structure
Change-Id: Iff2a9bef79f994e73eef3062b4dd5461bff968ab
2012-05-02 15:00:30 +00:00
&$module: ApiBase Module object
&$properties: Array of properties
2013-04-05 16:34:47 +00:00
'APIGetPossibleErrors': Use this hook to modify the module's list of possible
errors.
$module: ApiBase Module object
&$possibleErrors: Array of possible errors
2013-01-04 15:56:58 +00:00
'APIQueryAfterExecute': After calling the execute() method of an
2008-09-17 18:49:22 +00:00
action=query submodule. Use this to extend core API modules.
&$module: Module object
2013-01-04 15:56:58 +00:00
'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
an action=query submodule. Use this to extend core API modules.
2008-09-17 18:49:22 +00:00
&$module: Module object
&$resultPageSet: ApiPageSet object
2013-01-04 15:56:58 +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).
2008-07-04 12:07:02 +00:00
$tokenFunctions: array(action => callback)
2013-01-04 15:56:58 +00:00
'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).
2008-07-04 12:07:02 +00:00
$tokenFunctions: array(action => callback)
2013-01-04 15:56:58 +00:00
'APIQueryRecentChangesTokens': Use this hook to add custom tokens to
list=recentchanges. 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).
2008-09-04 15:17:51 +00:00
$tokenFunctions: array(action => callback)
2013-01-04 15:56:58 +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
2013-10-05 21:32:08 +00:00
'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
sites statistics information.
&$results: array of results, add things here
2013-01-04 15:56:58 +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).
2009-04-19 15:12:15 +00:00
$tokenFunctions: array(action => callback)
2013-01-04 15:56:58 +00:00
'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
an exception is thrown during API action execution.
2012-09-05 15:50:13 +00:00
$apiMain: Calling ApiMain instance.
$e: Exception object.
2013-01-04 15:56:58 +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.
2010-10-28 19:20:21 +00:00
&$apis: array of services
2013-01-04 15:56:58 +00:00
'ApiTokensGetTokenTypes': Use this hook to extend action=tokens with new token
types.
2012-04-25 08:48:53 +00:00
&$tokenTypes: supported token types in format 'type' => callback function
used to retrieve this type of tokens.
2013-10-29 11:15:18 +00:00
'Article::MissingArticleConditions': Before fetching deletion & move log entries
to display a message of a non-existing page being deleted/moved, give extensions
a chance to hide their (unrelated) log entries.
&$conds: Array of query conditions (all of which have to be met; conditions will
AND in the final query)
$logTypes: Array of log types being queried
2013-01-04 15:56:58 +00:00
'ArticleAfterFetchContent': After fetching content of an article from the
database. DEPRECATED, use ArticleAfterFetchContentObject instead.
2012-04-26 13:12:40 +00:00
$article: the article (object) being loaded from the database
&$content: the content (string) of the article
2013-01-04 15:56:58 +00:00
'ArticleAfterFetchContentObject': 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
2012-04-26 13:12:40 +00:00
&$content: the content of the article, as a Content object
2007-12-03 19:47:11 +00:00
2013-01-04 15:56:58 +00:00
'ArticleConfirmDelete': Before writing the confirmation form for article
deletion.
2011-04-13 23:36:27 +00:00
$article: the article (object) being deleted
2013-01-04 15:56:58 +00:00
$output: the OutputPage object
2011-04-13 23:36:27 +00:00
&$reason: the reason (string) the article is being deleted
2013-01-04 15:56:58 +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.
$diffEngine: the DifferenceEngine
$output: the OutputPage object
2010-10-26 22:34:18 +00:00
2013-01-04 15:56:58 +00:00
'ArticleDelete': Before an article is deleted.
2012-12-05 13:41:41 +00:00
$wikiPage: 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)
2012-05-14 01:20:05 +00:00
$status: Status object, modify this to throw an error. Overridden by $error
(added in 1.20)
2004-11-28 06:15:22 +00:00
2013-01-04 15:56:58 +00:00
'ArticleDeleteComplete': After an article is deleted.
2012-12-05 13:41:41 +00:00
$wikiPage: 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
2012-09-20 19:15:43 +00:00
$content: the Content of the deleted page
$logEntry: the ManualLogEntry used to record the deletion
2004-11-28 06:15:22 +00:00
2013-01-04 15:56:58 +00:00
'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
was changed.
2013-04-14 22:30:24 +00:00
&$wikiPage: WikiPage (object) of the user talk page
$recipient: User (object) who's talk page was edited
2007-12-03 19:47:11 +00:00
2013-01-04 15:56:58 +00:00
'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
article has been changed.
2012-12-05 13:41:41 +00:00
$wikiPage: 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
2013-01-04 15:56:58 +00:00
'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
recentchanges table, return false to not delete old entries.
2012-12-05 13:41:41 +00:00
$wikiPage: 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
2013-01-04 15:56:58 +00:00
Wiki::articleFromTitle().
$title: Title (object) used to create the article object
$article: Article (object) that will be returned
2013-12-11 21:59:48 +00:00
$context: IContextSource (object)
2007-12-03 19:47:11 +00:00
2013-01-04 15:56:58 +00:00
'ArticleInsertComplete': After a new article is created. DEPRECATED, use
PageContentInsertComplete.
2012-12-05 13:41:41 +00:00
$wikiPage: 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)
2012-08-28 14:02:13 +00:00
$flags: Flags passed to WikiPage::doEditContent()
2007-07-22 23:16:48 +00:00
$revision: New Revision of the article
2013-01-04 15:56:58 +00:00
'ArticleMergeComplete': After merging to article using Special:Mergehistory.
2007-12-03 19:47:11 +00:00
$targetTitle: target title (object)
2009-06-18 02:13:42 +00:00
$destTitle: destination title (object)
2007-12-03 19:47:11 +00:00
2013-01-04 15:56:58 +00:00
'ArticlePageDataAfter': After loading data of an article from the database.
2012-12-05 13:41:41 +00:00
$wikiPage: WikiPage (object) whose data were loaded
2007-12-03 19:47:11 +00:00
$row: row (object) returned from the database server
2013-01-04 15:56:58 +00:00
'ArticlePageDataBefore': Before loading data of an article from the database.
2012-12-05 13:41:41 +00:00
$wikiPage: WikiPage (object) that data will be loaded
2013-01-27 17:59:24 +00:00
$fields: fields (array) to load from the database
2007-12-03 19:47:11 +00:00
2013-01-04 15:56:58 +00:00
'ArticlePrepareTextForEdit': Called when preparing text to be saved.
2012-12-05 13:41:41 +00:00
$wikiPage: the WikiPage being saved
2011-01-16 21:12:26 +00:00
$popts: parser options to be used for pre-save transformation
2013-01-04 15:56:58 +00:00
'ArticleProtect': Before an article is protected.
2012-12-05 13:41:41 +00:00
$wikiPage: 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
2013-01-04 15:56:58 +00:00
'ArticleProtectComplete': After an article is protected.
2012-12-05 13:41:41 +00:00
$wikiPage: 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
2013-01-04 15:56:58 +00:00
'ArticlePurge': Before executing "&action=purge".
2012-12-05 13:41:41 +00:00
$wikiPage: WikiPage (object) to purge
2007-12-03 19:47:11 +00:00
2013-01-04 15:56:58 +00:00
'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
revisions of an article.
&$title: Title object of the article
2008-03-22 17:29:44 +00:00
2013-01-04 15:56:58 +00:00
'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)
2013-01-04 15:56:58 +00:00
'ArticleRollbackComplete': After an article rollback is completed.
2012-12-05 13:41:41 +00:00
$wikiPage: 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
2013-01-04 15:56:58 +00:00
'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
instead.
2012-12-05 13:41:41 +00:00
$wikiPage: 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 #
2013-01-04 15:56:58 +00:00
'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
PageContentSaveComplete instead.
2012-12-05 13:41:41 +00:00
$wikiPage: 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)
2012-08-28 14:02:13 +00:00
$flags: Flags passed to WikiPage::doEditContent()
2007-07-22 23:16:48 +00:00
$revision: New Revision of the article
2012-08-28 14:02:13 +00:00
$status: Status object about to be returned by doEditContent()
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
2013-01-04 15:56:58 +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
2013-01-04 15:56:58 +00:00
$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.
2014-05-21 02:37:19 +00:00
$oldPageId: ID of page previously deleted (from archive table)
2007-01-18 07:44:25 +00:00
2012-11-16 17:10:53 +00:00
'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
$pageArchive: the PageArchive object
&$logEntry: ManualLogEntry object
$user: User who is performing the log action
2013-01-04 15:56:58 +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
2013-05-29 19:29:42 +00:00
$patrolFooterShown: boolean whether patrol footer is shown
2011-01-14 21:54:29 +00:00
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
2013-01-04 15:56:58 +00:00
'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
redirect was followed.
2007-12-03 19:47:11 +00:00
$article: target article (object)
2007-08-15 22:13:03 +00:00
2013-01-04 15:56:58 +00:00
'ArticleViewCustom': Allows to output the text of the article in a different
format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
2013-01-27 17:59:24 +00:00
that it is preferable to implement proper handing for a custom data type using
2013-01-04 15:56:58 +00:00
the ContentHandler facility.
2011-08-11 17:21:31 +00:00
$text: text of the page
$title: title of the page
$output: reference to $wgOut
2013-01-04 15:56:58 +00:00
'ArticleContentViewCustom': Allows to output the text of the article in a
2013-01-27 17:59:24 +00:00
different format than wikitext. Note that it is preferable to implement proper
2013-01-04 15:56:58 +00:00
handing for a custom data type using the ContentHandler facility.
2012-04-26 13:12:40 +00:00
$content: content of the page, as a Content object
$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
2013-01-04 15:56:58 +00:00
in from an external authentication method.
2008-05-17 09:06:35 +00:00
$user: User object created locally
2013-01-04 15:56:58 +00:00
'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
2013-01-27 17:59:24 +00:00
Gives a chance for an extension to set it programmatically to a variable class.
2006-11-30 07:47:34 +00:00
&$auth: the $wgAuth object, probably a stub
2013-01-04 15:56:58 +00:00
'AutopromoteCondition': Check autopromote condition for user.
2007-12-23 18:33:46 +00:00
$type: condition type
$args: arguments
$user: user
$result: result of checking autopromote condition
2013-01-27 17:59:24 +00:00
'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
2011-08-13 22:42:09 +00:00
$table: table name
&$prefix: prefix
2013-01-04 15:56:58 +00:00
'BacklinkCacheGetConditions': Allows to set conditions for query when links to
certain title are fetched.
2011-08-13 22:42:09 +00:00
$table: table name
$title: title of the page to which backlinks are sought
&$conds: query conditions
2013-01-04 15:56:58 +00:00
'BadImage': When checking against the bad image list. 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.
2006-07-02 21:54:34 +00:00
$name: Image name being checked
&$bad: Whether or not the image is "bad"
2013-12-16 17:26:30 +00:00
'BaseTemplateAfterPortlet': After output of portlets, allow injecting
custom HTML after the section. Any uses of the hook need to handle escaping.
$template BaseTemplate
$portlet: string portlet name
&$html: string
2013-01-04 15:56:58 +00:00
'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
"noarticletext-nopermission" at Article::showMissingArticle().
2012-02-13 22:32:44 +00:00
$article: article object
2013-01-04 15:56:58 +00:00
'BeforeInitialize': Before anything is initialized in
MediaWiki::performRequest().
2009-08-03 22:31:52 +00:00
&$title: Title being used for request
2011-12-18 14:48:23 +00:00
$unused: null
2009-08-03 22:31:52 +00:00
&$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
2013-01-04 15:56:58 +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
2014-05-12 20:05:00 +00:00
'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
override how the redirect is output by modifying, or by returning false, and
letting standard HTTP rendering take place.
ATTENTION: This hook is likely to be removed soon due to overall design of the system.
$context: IContextSource object
&$redirect: string URL, modifiable
2011-12-14 00:38:21 +00:00
'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
override how the redirect is output by modifying, or by returning false and
taking over the output.
$out: OutputPage object
&$redirect: URL, modifiable
&$code: HTTP code (eg '301' or '302'), modifiable
2013-01-04 15:56:58 +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
2013-01-04 15:56:58 +00:00
FIXME: Where does the below sentence fit in?
2011-09-06 18:11:53 +00:00
If 'broken' is a key in $options then the file will appear as a broken thumbnail.
2013-01-04 15:56:58 +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
2013-01-04 15:56:58 +00:00
'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
2007-06-01 13:17:24 +00:00
&$parser: Parser object
&$ig: ImageGallery object
2013-01-04 15:56:58 +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-04-15 00:23:37 +00:00
2011-11-20 15:16:54 +00:00
'BitmapHandlerTransform': before a file is transformed, gives extension the
2011-03-18 22:28:19 +00:00
possibility to transform it themselves
2011-11-20 15:16:54 +00:00
$handler: BitmapHandler
2011-03-18 22:28:19 +00:00
$image: File
2011-11-20 15:16:54 +00:00
&$scalerParams: Array with scaler parameters
2011-03-18 22:28:19 +00:00
&$mto: null, set to a MediaTransformOutput
2013-01-04 15:56:58 +00:00
'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
normalizations have been performed, except for the $wgMaxImageArea check.
2011-11-02 20:48:50 +00:00
$image: File
&$params: Array of parameters
2013-01-04 15:56:58 +00:00
&$checkImageAreaHookResult: null, set to true or false to override the
$wgMaxImageArea check result.
2011-11-02 20:48:50 +00:00
2013-01-04 15:56:58 +00:00
'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
to a user.
2011-07-15 00:48:02 +00:00
$block: Block object (which is set to be autoblocking)
&$blockIds: Array of block IDs of the autoblock
2013-01-04 15:56:58 +00:00
'BlockIp': Before an IP address or user is blocked.
2004-11-27 23:57:55 +00:00
$block: the Block object about to be saved
$user: the user _doing_ the block (not the one being blocked)
2014-01-18 21:31:47 +00:00
&$reason: if the hook is aborted, the error message to be returned in an array
2004-11-27 23:57:55 +00:00
2013-01-04 15:56:58 +00:00
'BlockIpComplete': After an IP address or user is blocked.
2004-11-27 23:57:55 +00:00
$block: the Block object that was saved
$user: the user who did the block (not the one being blocked)
2013-01-04 15:56:58 +00:00
'BookInformation': Before information output on Special:Booksources.
2007-01-16 19:06:56 +00:00
$isbn: ISBN to show information for
$output: OutputPage object in use
2010-08-24 19:58:55 +00:00
2013-08-21 01:39:45 +00:00
'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
to be able to access the wiki via HTTPS.
$ip: The IP address in human-readable form
2013-11-10 10:07:58 +00:00
&$canDo: This reference should be set to false if the client may not be able
2013-08-21 01:39:45 +00:00
to use HTTPS
2013-01-04 15:56:58 +00:00
'CanonicalNamespaces': For extensions adding their own namespaces or altering
the defaults.
2013-07-31 01:44:01 +00:00
Note that if you need to specify namespace protection or content model for
a namespace that is added in a CanonicalNamespaces hook handler, you
should do so by altering $wgNamespaceProtection and
$wgNamespaceContentModels outside the handler, in top-level scope. The
point at which the CanonicalNamespaces hook fires is too late for altering
these variables. This applies even if the namespace addition is
conditional; it is permissible to declare a content model and protection
for a namespace and then decline to actually register it.
2010-08-24 20:12:15 +00:00
&$namespaces: Array of namespace numbers with corresponding canonical names
2011-11-20 15:16:54 +00:00
2013-03-05 22:43:03 +00:00
'CategoryAfterPageAdded': After a page is added to a category.
$category: Category that page was added to
$wikiPage: WikiPage that was added
'CategoryAfterPageRemoved': After a page is removed from a category.
$category: Category that page was removed from
$wikiPage: WikiPage that was removed
2013-01-04 15:56:58 +00:00
'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
2007-08-28 21:53:50 +00:00
$catpage: CategoryPage instance
2013-01-04 15:56:58 +00:00
'ChangePasswordForm': For extensions that need to add a field to the
ChangePassword form via the Preferences form.
&$extraFields: An array of arrays that hold fields like would be passed to the
pretty function.
2012-06-13 16:34:32 +00:00
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).
2013-01-04 15:56:58 +00:00
&$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.
2007-11-06 01:16:25 +00:00
2014-03-03 21:26:54 +00:00
'ChangesListInitRows': Batch process change list rows prior to rendering.
$changesList: ChangesList instance
$rows: The data that will be rendered. May be a ResultWrapper instance or
an array.
2014-01-08 17:17:08 +00:00
'ChangesListSpecialPageFilters': Called after building form options on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
$special: ChangesListSpecialPage instance
&$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.
'ChangesListSpecialPageQuery': Called when building SQL query on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
$name: name of the special page, e.g. 'Watchlist'
&$tables: array of tables to be queried
&$fields: array of columns to select
&$conds: array of WHERE conditionals for query
&$query_options: array of options for the database request
&$join_conds: join conditions for the tables
$opts: FormOptions for this request
2013-01-04 15:56:58 +00:00
'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
2011-07-05 05:33:54 +00:00
$collationName: Name of the collation in question
2013-01-04 15:56:58 +00:00
&$collationObject: Null. Replace with a subclass of the Collation class that
implements the collation given in $collationName.
2011-07-05 05:33:54 +00:00
2013-01-04 15:56:58 +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
2013-01-27 17:59:24 +00:00
'ContentHandlerDefaultModelFor': Called when the default content model is determined
2012-04-26 13:12:40 +00:00
for a given title. May be used to assign a different model for that title.
$title: the Title in question
&$model: the model name. Use with CONTENT_MODEL_XXX constants.
2012-05-13 22:02:29 +00:00
'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
2012-11-17 05:19:48 +00:00
content model name, but no entry for that model exists in $wgContentHandlers.
2012-04-26 13:12:40 +00:00
$modeName: the requested content model name
&$handler: set this to a ContentHandler object, if desired.
2013-12-10 13:36:52 +00:00
'ContentModelCanBeUsedOn': Called to determine whether that content model can
be used on a given page. This is especially useful to prevent some content models
to be used in some special location.
$contentModel: ID of the content model in question
$title: the Title in question.
&$ok: Output parameter, whether it is OK to use $contentModel on $title.
Handler functions that modify $ok should generally return false to prevent further
hooks from further modifying $ok.
2012-10-16 10:38:20 +00:00
'ContentGetParserOutput': Customize parser output for a given content object,
called by AbstractContent::getParserOutput. May be used to override the normal
model-specific rendering of page content.
$content: The Content to render
$title: Title of the page, as context
$revId: The revision ID, as context
$options: ParserOptions for rendering. To avoid confusing the parser cache,
the output can only depend on parameters provided to this hook function, not on global state.
$generateHtml: boolean, indicating whether full HTML should be generated. If false,
generation of HTML may be skipped, but other information should still be present in the
ParserOutput object.
&$output: ParserOutput, to manipulate or replace
2012-11-05 15:53:48 +00:00
'ConvertContent': Called by AbstractContent::convert when a conversion to another
content model is requested.
$content: The Content object to be converted.
$toModel: The ID of the content model to convert to.
$lossy: boolean indicating whether lossy conversion is allowed.
&$result: Output parameter, in case the handler function wants to provide a
converted Content object. Note that $result->getContentModel() must return $toModel.
Handler functions that modify $result should generally return false to further
attempts at conversion.
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
2012-07-02 13:31:06 +00:00
'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
&$data: an array of results of all contribs queries
$pager: The ContribsPager object hooked into
$offset: Index offset, inclusive
$limit: Exact query limit
$descending: Query direction, false for ascending, true for descending
2008-07-20 13:55:35 +00:00
'ContributionsLineEnding': Called before a contributions HTML line is finished
$page: SpecialPage object for contributions
2012-07-03 17:38:09 +00:00
&$ret: the HTML line
2008-07-20 13:55:35 +00:00
$row: the DB row for this line
2012-07-03 17:38:09 +00:00
&$classes: the classes to add to the surrounding <li>
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
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
2013-03-07 02:38:00 +00:00
'DiffRevisionTools': Override or extend the revision tools available from the
diff view, i.e. undo, etc.
2014-01-03 21:11:48 +00:00
$newRev: Revision object of the "new" revision
2013-03-07 02:38:00 +00:00
&$links: Array of HTML links
2014-01-03 21:11:48 +00:00
$oldRev: Revision object of the "old" revision (may be null)
2013-03-07 02:38:00 +00:00
2013-01-04 20:33:37 +00:00
'DiffViewHeader': Called before diff display
2006-05-24 09:05:49 +00:00
$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
2013-11-22 19:59:47 +00:00
the page title, if the section is included from a template)
2008-07-28 23:52:55 +00:00
$section: The designation of the section being pointed to, to be included in
the link, like "§ion=$section"
2012-08-29 08:07:10 +00:00
$tooltip: The default tooltip. Escape before using.
2008-07-28 23:52:55 +00:00
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
2012-08-29 08:07:10 +00:00
$lang: The language code to use for the link in the wfMessage function
2008-07-28 23:52:55 +00:00
2007-12-10 12:51:45 +00:00
'EditFilter': Perform checks on an edit
2012-10-24 08:17:19 +00:00
$editor: EditPage instance (object). The edit form (see includes/EditPage.php)
2007-12-10 12:51:45 +00:00
$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
2012-04-26 13:12:40 +00:00
'EditFilterMerged': Post-section-merge edit filter.
DEPRECATED, use EditFilterMergedContent instead.
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
2013-01-03 10:30:46 +00:00
'EditFilterMergedContent': Post-section-merge edit filter.
This may be triggered by the EditPage or any other facility that modifies page content.
Use the $status object to indicate whether the edit should be allowed, and to provide
a reason for disallowing it. Return false to abort the edit, and true to continue.
Returning true if $status->isOK() returns false means "don't save but continue user
interaction", e.g. show the edit form.
$context: object implementing the IContextSource interface.
$content: content of the edit box, as a Content object.
$status: Status object to represent errors, etc.
2012-04-26 13:12:40 +00:00
$summary: Edit summary for page
2013-01-03 10:30:46 +00:00
$user: the User object representing the user whois performing the edit.
$minoredit: whether the edit was marked as minor by the user.
2012-04-26 13:12:40 +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
2013-01-04 20:33:37 +00:00
'EditPage::attemptSave': Called before an article is
2012-08-28 14:02:13 +00:00
saved, that is before WikiPage::doEditContent() 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
2011-11-20 15:16:54 +00:00
$editpage: EditPage instance
2009-07-08 18:47:46 +00:00
$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
2012-02-15 19:32:36 +00:00
$editor: the EditPage instance for reference
$out: an OutputPage instance to write to
2007-04-02 21:53:06 +00:00
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)
2012-02-15 19:32:36 +00:00
$out: an OutputPage instance to write to
2007-12-03 19:47:11 +00:00
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
2014-06-21 01:21:46 +00:00
'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
but for the read-only 'view source' variant of the edit form.
2014-03-23 20:07:39 +00:00
$editor: EditPage instance (object)
&$out: an OutputPage instance to write to
2014-06-21 01:21:46 +00:00
return value is ignored (should always return true)
2014-03-23 20:07:39 +00:00
2012-11-10 00:54:57 +00:00
'EditPage::showStandardInputs:options': allows injection of form fields into
the editOptions area
$editor: EditPage instance (object)
$out: an OutputPage instance to write to
2012-11-26 17:57:25 +00:00
&$tabindex: HTML tabindex of the last edit check/button
2012-11-10 00:54:57 +00:00
return value is ignored (should always be true)
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
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
textarea in the edit form.
2009-07-07 16:45:12 +00:00
&$toolbar: The toolbar HTMl
2013-01-04 20:33:37 +00:00
'EditPageCopyrightWarning': Allow for site and per-namespace customization of
contribution/copyright notice.
2009-06-24 16:49:28 +00:00
$title: title of page being edited
2013-01-04 20:33:37 +00:00
&$msg: localization message name, overridable. Default is either
'copyrightwarning' or 'copyrightwarning2'.
2009-06-24 16:49:28 +00:00
2013-01-04 20:33:37 +00:00
'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
modifying the wikitext that will be used in "Show changes". Note that it is
2013-01-27 17:59:24 +00:00
preferable to implement diff handling for different data types using the
2013-01-04 20:33:37 +00:00
ContentHandler facility.
2010-02-20 17:05:56 +00:00
$editPage: EditPage object
&$newtext: wikitext that will be used as "your version"
2012-04-26 13:12:40 +00:00
'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
2013-01-27 17:59:24 +00:00
"Show changes". Note that it is preferable to implement diff handling for
2013-01-04 20:33:37 +00:00
different data types using the ContentHandler facility.
2012-04-26 13:12:40 +00:00
$editPage: EditPage object
&$newtext: wikitext that will be used as "your version"
2013-01-04 20:33:37 +00:00
'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
2013-01-27 17:59:24 +00:00
Allow modifying the wikitext that will be previewed. Note that it is preferable
to implement previews for different data types using the ContentHandler
2013-01-04 20:33:37 +00:00
facility.
2010-02-20 17:05:56 +00:00
$editPage: EditPage object
&$toparse: wikitext that will be parsed
2013-01-04 20:33:37 +00:00
'EditPageGetPreviewContent': Allow modifying the wikitext that will be
2013-01-27 17:59:24 +00:00
previewed. Note that it is preferable to implement previews for different data
types using the ContentHandler facility.
2012-04-26 13:12:40 +00:00
$editPage: EditPage object
&$content: Content object to be previewed (may be replaced by hook function)
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
2013-01-04 20:33:37 +00:00
'EditPageTosSummary': Give a chance for site and per-namespace customizations
2009-06-24 16:49:28 +00:00
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'
2013-01-04 20:33:37 +00:00
'EmailConfirmed': When checking that the user's email address is "confirmed".
2006-05-02 20:07:54 +00:00
$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.
2013-01-04 20:33:37 +00:00
'EmailUser': Before sending email from one user to another.
2004-11-29 04:23:12 +00:00
$to: address of receiving user
$from: address of sending user
$subject: subject of the mail
$text: text of the mail
2013-01-04 20:33:37 +00:00
'EmailUserCC': Before sending the copy of the email to the author.
2010-04-13 17:33:22 +00:00
$to: address of receiving user
$from: address of sending user
$subject: subject of the mail
$text: text of the mail
2013-01-04 20:33:37 +00:00
'EmailUserComplete': After sending email from one user to another.
2004-11-29 04:23:12 +00:00
$to: address of receiving user
$from: address of sending user
$subject: subject of the mail
$text: text of the mail
2013-01-04 20:33:37 +00:00
'EmailUserForm': After building the email user form object.
2010-04-13 17:33:22 +00:00
$form: HTMLForm object
2013-01-04 20:33:37 +00:00
'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
user.
2009-05-28 12:32:43 +00:00
$user: The user who is trying to email another user.
$editToken: The user's edit token.
2013-01-04 20:33:37 +00:00
&$hookErr: Out-param for the error. Passed as the parameters to
OutputPage::showErrorPage.
2009-05-28 12:32:43 +00:00
2013-01-04 20:33:37 +00:00
'ExemptFromAccountCreationThrottle': Exemption from the account creation
throttle.
2011-08-21 16:38:02 +00:00
$ip: The ip address of the user
2013-01-04 20:33:37 +00:00
'ExtensionTypes': Called when generating the extensions credits, use this to
change the tables headers.
2011-06-13 14:55:03 +00:00
&$extTypes: associative array of extensions types
2013-01-04 20:33:37 +00:00
'ExtractThumbParameters': Called when extracting thumbnail parameters from a
thumbnail file name.
2013-06-17 03:06:33 +00:00
DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
2011-12-08 03:43:07 +00:00
$thumbname: the base name of the thumbnail file
&$params: the currently extracted params (has source name, temp or archived zone)
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'FileDeleteComplete': When a file is deleted.
2008-03-01 13:35:01 +00:00
$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
2013-01-04 20:33:37 +00:00
WikiFilePage associated with the file.
2008-03-01 13:35:01 +00:00
$user: user who performed the deletion
$reason: reason
2013-01-04 20:33:37 +00:00
'FileTransformed': When a file is transformed and moved into storage.
2012-04-23 18:06:05 +00:00
$file: reference to the File object
$thumb: the MediaTransformOutput object
$tmpThumbPath: The temporary file system path of the transformed file
$thumbPath: The permanent storage path of the transformed file
2013-01-04 20:33:37 +00:00
'FileUpload': When a file upload occurs.
2007-04-10 02:18:42 +00:00
$file : Image object representing the file that was uploaded
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'FormatAutocomments': When an autocomment is formatted by the Linker.
&$comment: Reference to the accumulated comment. Initially null, when set the
default code will be skipped.
2012-06-15 09:40:40 +00:00
$pre: Initial part of the parsed comment before the call to the hook.
$auto: The extracted part of the parsed comment before the call to the hook.
$post: The final part of the parsed comment before the call to the hook.
$title: An optional title object used to links to sections. Can be null.
$local: Boolean indicating whether section links should refer to local page.
New more slick gallery display
This extension adds a "mode" parameter to the gallery
tag, allowing different formats for the gallery tag
(galleries in the ui can be controlled by a global)
The added modes are:
*traditional - The original gallery
*nolines - Like the original, no borders, less padding
*packed - All images aligned by having same height.
JS also justifies the images.
(I think this one is the one that will go over best
with users.)
*packed-overlay - like packed, but caption goes over
top the image in a transloucent box.
*packed-hover - like packed-overlay, but caption only
visible on hover. Degrades gracefully on screen
readers, and falls back to packed-overlay if
you are using a touch screen. I kind of like
this mode when the caption is not that important
(ex a category where its just the file name).
This also adds a hook to allow people to make their
own gallery version. I believe there would be interest
in this, as different people have done different
experiments. For example:
* Wikia: http://community.wikia.com/wiki/Help:Galleries,_Slideshows,_and_Sliders/wikitext
* Wikinews: https://en.wikinews.org/wiki/Template:Picture_select
What I would like to see for this patch, is first it gets
enabled, with the default still "traditional". After
about a month or two we consult with users. If feedback
is positive, we change the default mode to one of the
others (probably "packed").
Adds a "mode" parameter to gallery for different
mode, including one 'height-constrained-overlay'
which looks much more like other modern websites.
Note: This makes one change to the old gallery format.
It makes Nonexistent files be rendered like thumbnails
(i.e. they are rendered with a little grey border).
One thing I'm slightly worried about with this patch,
is that I added an option to MediaTransformOutput::toHtml
to override the width attribute. I'm not sure if that
is the best approach, and would appreciate thoughts
on that.
This should be merged at the same time as Ie82c1548
Change-Id: I33462a8b52502ed76aeb163b66e3704c8618ba23
2013-06-08 04:47:07 +00:00
'GalleryGetModes': Get list of classes that can render different modes of a
gallery
$modeArray: An associative array mapping mode names to classes that implement
that mode. It is expected all registered classes are a subclass of
ImageGalleryBase.
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'GetCacheVaryCookies': Get cookies that should vary cache options.
2008-04-10 14:28:56 +00:00
$out: OutputPage object
&$cookies: array of cookies name, add a value to it if you want to add a cookie
2013-01-04 20:33:37 +00:00
that have to vary cache options
2008-04-10 14:28:56 +00:00
2013-01-04 20:33:37 +00:00
'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
notifications.
2011-08-19 14:05:00 +00:00
$title: Title object of page
$url: string value as output (out parameter, can modify)
$query: query options passed to Title::getCanonicalURL()
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.
2013-01-04 20:33:37 +00:00
'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
underscore) magic words. Called by MagicWord.
2012-12-25 06:40:41 +00:00
&$doubleUnderscoreIDs: array of strings
2013-08-12 16:18:29 +00:00
'GetExtendedMetadata': Get extended file metadata for the API
&$combinedMeta: Array of the form: 'MetadataPropName' => array(
'value' => prop value, 'source' => 'name of hook' ).
$file: File object of file in question
$context: RequestContext (including language to use)
2013-10-28 18:18:05 +00:00
$single: Only extract the current language; if false, the prop value should
be in the metadata multi-language array format:
mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
2013-08-12 16:18:29 +00:00
&$maxCacheTime: how long the results can be cached
2013-01-04 20:33:37 +00:00
'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
2007-12-10 12:51:45 +00:00
$title: Title object of page
$url: string value as output (out parameter, can modify)
$query: query options passed to Title::getFullURL()
2013-01-24 21:14:21 +00:00
'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
output.
&$output: string for the output timestamp
$timestamp: MWTimestamp object of the current (user-adjusted) timestamp
$relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
$user: User whose preferences are being used to make timestamp
$lang: Language that will be used to render the timestamp
2013-01-04 20:33:37 +00:00
'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
2005-12-26 07:14:42 +00:00
$title: Title object of page
$url: string value as output (out parameter, can modify)
$query: query options passed to Title::getInternalURL()
2013-01-04 20:33:37 +00:00
'GetIP': modify the ip of the current user (called only once).
2010-09-11 13:45:51 +00:00
&$ip: string holding the ip as determined so far
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +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()
2013-01-04 20:33:37 +00:00
'GetLocalURL::Internal': Modify local URLs to internal pages.
2011-08-12 19:23:43 +00:00
$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-08-12 19:23:43 +00:00
2013-01-04 20:33:37 +00:00
'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
without any fancy queries or variants.
2011-08-12 19:23:43 +00:00
$title: Title object of page
&$url: string value as output (out parameter, can modify)
2005-12-26 07:14:42 +00:00
2013-11-12 23:30:04 +00:00
'GetLogTypesOnUser': Add log types where the target is a userpage
&$types: Array of log types
2013-01-04 20:33:37 +00:00
'GetMetadataVersion': Modify the image metadata version currently in use. This
2013-01-27 17:59:24 +00:00
is used when requesting image metadata from a ForeignApiRepo. Media handlers
2013-01-04 20:33:37 +00:00
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.
2011-04-16 01:23:15 +00:00
&$version: Array of version strings
2013-05-05 01:08:58 +00:00
'GetNewMessagesAlert': Disable or modify the new messages alert
&$newMessagesAlert: An empty string by default. If the user has new talk page
messages, this should be populated with an alert message to that effect
$newtalks: An empty array if the user has no new messages or an array containing
links and revisions if there are new messages (See User::getNewMessageLinks)
$user: The user object of the user who is loading the page
$out: OutputPage object (to check what type of page the user is on)
2013-01-04 20:33:37 +00:00
'GetPreferences': Modify user preferences.
2009-04-24 01:31:17 +00:00
$user: User whose preferences are being modified.
&$preferences: Preferences description array, to be fed to an HTMLForm object
2013-01-24 22:38:36 +00:00
'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
output.
&$output: string for the output timestamp
&$diff: DateInterval representing the difference between the timestamps
$timestamp: MWTimestamp object of the current (user-adjusted) timestamp
$relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
$user: User whose preferences are being used to make timestamp
$lang: Language that will be used to render the timestamp
2008-01-02 02:05:01 +00:00
'getUserPermissionsErrors': Add a permissions error when permissions errors are
2013-01-04 20:33:37 +00:00
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.
2013-01-04 20:33:37 +00:00
'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
called only if expensive checks are enabled. Add a permissions error when
permissions errors are checked for. 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.
2008-01-14 13:50:55 +00:00
2013-01-04 20:33:37 +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.
2012-04-16 16:57:58 +00:00
2013-01-04 20:33:37 +00:00
'GitViewers': Called when generating the list of git viewers for
Special:Version, use this to change the list.
&$extTypes: associative array of repo URLS to viewer URLs.
2012-04-16 16:57:58 +00:00
2013-03-07 02:38:00 +00:00
'HistoryRevisionTools': Override or extend the revision tools available from the
page history view, i.e. undo, rollback, etc.
$rev: Revision object
&$links: Array of HTML links
2008-02-26 17:20:39 +00:00
'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
2013-01-04 20:33:37 +00:00
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
2013-01-04 20:33:37 +00:00
includes/Linker.php for Linker::makeImageLink
2008-02-26 17:20:39 +00:00
&$handlerParams: Various parameters with special meanings; see documentation in
2013-01-04 20:33:37 +00:00
includes/Linker.php for Linker::makeImageLink
2008-02-26 17:20:39 +00:00
&$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
2013-01-04 20:33:37 +00:00
the image on an image page.
2008-05-17 00:08:31 +00:00
$imagePage: ImagePage object ($this)
$output: $wgOut
2013-01-04 20:33:37 +00:00
'ImagePageAfterImageLinks': Called after the image links section on an image
page is built.
2009-11-07 09:31:16 +00:00
$imagePage: ImagePage object ($this)
&$html: HTML for the hook to add
2013-01-27 17:59:24 +00:00
'ImagePageFileHistoryLine': Called when a file history line is constructed.
2008-05-17 00:08:31 +00:00
$file: the file
$line: the HTML of the history line
$css: the line CSS class
2013-01-04 20:33:37 +00:00
'ImagePageFindFile': Called when fetching the file associated with an image
page.
2008-05-24 20:51:08 +00:00
$page: ImagePage object
&$file: File object
&$displayFile: displayed File object
2013-01-04 20:33:37 +00:00
'ImagePageShowTOC': Called when the file toc on an image page is generated.
2009-11-08 11:09:20 +00:00
$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
2013-01-04 20:33:37 +00:00
using img_auth.php.
2009-11-07 10:33:10 +00:00
&$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
2013-01-04 20:33:37 +00:00
server
2009-11-07 10:33:10 +00:00
&$name: the name only component of the file
&$result: The location to pass back results of the hook routine (only used if
2013-01-04 20:33:37 +00:00
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.
2009-11-07 10:33:10 +00:00
2013-01-04 20:33:37 +00:00
'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
2010-07-03 14:33:09 +00:00
$reader: XMLReader object
$logInfo: Array of information
Return false to stop further processing of the tag
2013-01-04 20:33:37 +00:00
'ImportHandlePageXMLTag': When parsing a XML tag in a page.
2010-07-03 14:33:09 +00:00
$reader: XMLReader object
$pageInfo: Array of information
Return false to stop further processing of the tag
2013-01-04 20:33:37 +00:00
'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
2010-07-03 14:33:09 +00:00
$reader: XMLReader object
2012-01-16 15:49:32 +00:00
$pageInfo: Array of page information
$revisionInfo: Array of revision information
2010-07-03 14:33:09 +00:00
Return false to stop further processing of the tag
2013-01-04 20:33:37 +00:00
'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
2010-07-03 14:33:09 +00:00
$reader: XMLReader object
Return false to stop further processing of the tag
2013-01-04 20:33:37 +00:00
'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
2010-07-03 14:33:09 +00:00
$reader: XMLReader object
$revisionInfo: Array of information
Return false to stop further processing of the tag
2009-11-07 10:33:10 +00:00
2013-01-04 20:33:37 +00:00
'InfoAction': When building information to display on the action=info page.
2012-10-07 21:34:02 +00:00
$context: IContextSource object
&$pageInfo: Array of information
2013-01-04 20:33:37 +00:00
'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
2013-11-22 19:59:47 +00:00
$title: Title object for the current page
2008-07-04 09:38:12 +00:00
$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.
2011-11-20 15:16:54 +00:00
&$iwData: output array describing the interwiki with keys iw_url, iw_local,
2011-03-17 15:51:19 +00:00
iw_trans and optionally iw_api and iw_wikiid.
2013-01-04 20:33:37 +00:00
'InternalParseBeforeSanitize': during Parser's internalParse method just before
the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
template/parser function execution which respect nowiki and HTML-comments.
2012-06-24 20:43:17 +00:00
&$parser: Parser object
&$text: string containing partially parsed text
&$stripState: Parser's internal StripState object
2009-05-28 17:05:09 +00:00
'InternalParseBeforeLinks': during Parser's internalParse method before links
2012-06-24 20:43:17 +00:00
but after nowiki/noinclude/includeonly/onlyinclude and other processings.
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
2013-01-04 20:33:37 +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
2014-03-24 22:59:08 +00:00
$rc: RecentChange object that triggered url generation
2011-08-19 14:05:00 +00:00
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()
2013-05-23 10:16:38 +00:00
'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
$url: URL used to upload from
&$allowed: Boolean indicating if uploading is allowed for given URL
2013-01-04 20:33:37 +00:00
'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for
instance to return false if the domain name doesn't match your organization.
2007-10-21 17:15:37 +00:00
$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-12-12 19:32:59 +00:00
'Language::getMessagesFileName':
$code: The language code or the language we're looking for a messages file for
&$file: The messages file path, you can override this to change the location.
2011-08-30 13:24:27 +00:00
'LanguageGetNamespaces': Provide custom ordering for namespaces or
2011-11-20 15:16:54 +00:00
remove namespaces. Do not use this hook to add namespaces. Use
2011-08-30 13:59:54 +00:00
CanonicalNamespaces for that.
2011-08-30 13:24:27 +00:00
&$namespaces: Array of namespaces indexed by their numbers
2011-11-20 15:16:54 +00:00
'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
$wgExtensionMessagesFiles instead.
* 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
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
2013-01-27 17:59:24 +00:00
$lang: language code (string)
2007-12-10 12:51:45 +00:00
* 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
2013-01-27 17:59:24 +00:00
$lang: language code (string)
2007-12-10 12:51:45 +00:00
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
2013-04-19 11:19:06 +00:00
'LanguageLinks': Manipulate a page's language links. This is called
in various places to allow extensions to define the effective language
links for a page.
$title: The page's Title.
&$links: Associative array mapping language codes to prefixed links of the
form "language:title".
&$linkFlags: Associative array mapping prefixed links to arrays of flags.
Currently unused, but planned to provide support for marking individual
language links in the UI, e.g. for featured articles.
2008-08-05 17:05:59 +00:00
'LinkBegin': Used when generating internal and interwiki links in
2013-01-04 20:33:37 +00:00
Linker::link(), before processing starts. Return false to skip default
processing and return $ret. See documentation for Linker::link() for details on
the expected meanings of parameters.
2008-08-05 17:05:59 +00:00
$skin: the Skin object
$target: the Title that the link is pointing to
2013-01-04 20:33:37 +00:00
&$html: the contents that the <a> tag should have (raw HTML); null means
"default".
&$customAttribs: the HTML attributes that the <a> tag should have, in
associative array form, with keys and values unescaped. Should be merged with
default values, with a value of false meaning to suppress the attribute.
2008-08-05 17:05:59 +00:00
&$query: the query string to add to the generated URL (the bit after the "?"),
2013-01-04 20:33:37 +00:00
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
2013-01-04 20:33:37 +00:00
with HTML attributes $attribs and contents $html will be returned. If you
return false, $ret will be returned.
2008-08-05 17:05:59 +00:00
$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
2013-01-04 20:33:37 +00:00
include 'noclasses'.
2011-05-09 02:55:17 +00:00
&$html: the final (raw HTML) contents of the <a> tag, after processing.
2013-01-27 17:59:24 +00:00
&$attribs: the final HTML attributes of the <a> tag, after processing, in
associative array form.
2008-08-05 17:05:59 +00:00
&$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
2013-01-04 20:33:37 +00:00
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
2013-01-04 20:33:37 +00:00
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
2014-03-25 10:56:41 +00:00
'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
before the return.
$title: the Title object that the link is pointing to
$file: the File object or false if broken link
&$html: the link text
&$attribs: the attributes to be applied
&$ret: the value to return if your hook returns false
2009-05-28 17:05:09 +00:00
'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
2013-01-04 20:33:37 +00:00
actual update.
2010-03-09 20:40:00 +00:00
&$linksUpdate: the LinksUpdate object
2008-02-09 12:32:32 +00:00
2012-12-31 22:30:32 +00:00
'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
each link table insert. For example, pagelinks, imagelinks, externallinks.
$linksUpdate: LinksUpdate object
$table: the table to insert links to
2013-01-27 17:59:24 +00:00
$insertions: an array of links to insert
2012-12-31 22:30:32 +00:00
'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
including delete and insert, has completed for all link tables
2010-03-09 20:40:00 +00:00
&$linksUpdate: the LinksUpdate object
2008-02-09 12:32:32 +00:00
2013-01-27 17:59:24 +00:00
'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
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.
2013-01-04 20:33:37 +00:00
'LoadExtensionSchemaUpdates': Called during database installation and updates.
2010-08-15 18:55:08 +00:00
&updater: A DatabaseUpdater subclass
2007-12-03 19:47:11 +00:00
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
2011-10-28 22:21:03 +00:00
$file: the File object
2011-11-15 02:20:08 +00:00
$archiveName: name of an old file version or false if it's the current one
2011-10-28 22:21:03 +00:00
2013-01-04 20:33:37 +00:00
'LocalisationCacheRecache': Called when loading the localisation data into
cache.
2009-07-19 20:03:13 +00:00
$cache: The LocalisationCache object
$code: language code
&$alldata: The localisation data from core and extensions
2013-12-28 08:58:41 +00:00
&purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
2009-07-19 20:03:13 +00:00
2013-11-10 10:07:58 +00:00
'LocalisationChecksBlacklist': When fetching the blacklist of
localisation checks.
&$blacklist: array of checks to blacklist. See the bottom of
maintenance/language/checkLanguage.inc for the format of this variable.
2014-05-13 19:45:28 +00:00
'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
optional localisation messages
&$ignored Array of ignored message keys
&$optional Array of optional message keys
2013-01-04 20:33:37 +00:00
'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
Returning false will prevent the string from being added to the OutputPage.
2011-09-16 23:14:13 +00:00
&$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:
2013-01-04 20:33:37 +00:00
- 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
wfMessage()->params()->parseAsBlock()
- 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)
'LoginAuthenticateAudit': A login attempt for a valid user account either
2012-02-06 22:44:30 +00:00
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
2013-01-04 20:33:37 +00:00
value (SUCCESS, WRONG_PASS, etc.).
2007-05-07 21:54:06 +00:00
Password Expiration
Add functionality to expire users' passwords:
* Adds column to the user table to keep a password expiration
* Adds $wgPasswordExpirationDays, which will force users to reset
their passwords after a set number of days. By default, this set
to false, so passwords never expire.
* Adds a default grace period of 7 days, where if the user's password
is expired, they can still login, but are encouraged to reset their
password.
* Adds hook 'LoginPasswordResetMessage' to update reset message, in
case an extension wants to vary the message on a particular reset
event.
* Adds hook 'ResetPasswordExpiration' to allow extensions to change
the expiration date when the user resets their password. E.g., if
an extension wants to vary the expiration based on the user's group.
If the user is in the grace period, they get a password reset form
added to the login successful page. If an extension prevents showing
the login successful page (like CentralAuth), it should be updated to
show a password change form during the grace period. After the grace
period, the user will not be able to login without changing their
password.
Also prevents a successful reset if the user is "changing" their
password to their existing password.
No passwords will expire by default. Sites will have to call
User->expirePassword() from their own maintenance script to trigger a
password reset for a user.
Bug: 54997
Change-Id: I92a9fc63b409b182b1d7b48781d73fc7216f8061
2013-10-09 18:09:28 +00:00
'LoginPasswordResetMessage': User is being requested to reset their password on login.
Use this hook to change the Message that will be output on Special:ChangePassword.
&$msg: Message object that will be shown to the user
$username: Username of the user who's password was expired.
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
logging.log_type database field.
2009-05-28 17:05:09 +00:00
$log_action: string for the type of log action (e.g. 'delete', 'block',
2013-01-04 20:33:37 +00:00
'create2'). Corresponds to logging.log_action database field.
2009-05-28 17:05:09 +00:00
$title: Title object that corresponds to logging.log_namespace and
2013-01-04 20:33:37 +00:00
logging.log_title database fields.
2009-05-28 17:05:09 +00:00
$paramArray: Array of parameters that corresponds to logging.log_params field.
2013-01-04 20:33:37 +00:00
Note that only $paramArray[0] appears to contain anything.
2009-05-28 17:05:09 +00:00
&$comment: string that corresponds to logging.log_comment database field, and
2013-01-04 20:33:37 +00:00
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
2014-01-08 19:51:54 +00:00
'LonelyPagesQuery': Allow extensions to modify the query used by
Special:LonelyPages.
&$tables: tables to join in the query
&$conds: conditions for the query
&$joinConds: join conditions for the query
2013-01-04 20:33:37 +00:00
'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
script.
2011-06-13 14:55:03 +00:00
$refreshLinks: RefreshLinks object
2013-01-27 17:59:24 +00:00
'MagicWordwgVariableIDs': When defining new magic words IDs.
2007-12-03 19:47:11 +00:00
$variableIDs: array of strings
2013-01-04 20:33:37 +00:00
'MakeGlobalVariablesScript': Called right before Skin::makeVariablesScript is
executed. Ideally, this hook should only be used to add variables that depend on
the current page/request; static configuration should be added through
ResourceLoaderGetConfigVars instead.
&$vars: variable (or multiple variables) to be added into the output of
Skin::makeVariablesScript
$out: The OutputPage which called the hook, can be used to get the real title.
2008-08-01 22:38:11 +00:00
2013-01-27 17:59:24 +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
2013-01-04 20:33:37 +00:00
$wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
sysop in order to mark an edit patrolled.
2006-01-03 15:45:36 +00:00
2013-01-04 20:33:37 +00:00
'MarkPatrolledComplete': After an edit is marked patrolled.
2006-01-03 15:45:36 +00:00
$rcid: ID of the revision marked as patrolled
$user: user (object) who marked the edit patrolled
2013-01-04 20:33:37 +00:00
$wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
sysop to patrol the edit.
2006-01-03 15:45:36 +00:00
2013-01-04 20:33:37 +00:00
'MediaWikiPerformAction': Override MediaWiki::performAction(). 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
2013-11-01 21:13:15 +00:00
$article: Article on which the action will be performed
2013-11-22 19:59:47 +00:00
$title: Title on which the action will be performed
2009-11-17 20:52:04 +00:00
$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
2013-01-04 20:33:37 +00:00
'MessagesPreLoad': When loading a message from the database.
2007-12-03 19:47:11 +00:00
$title: title of the message (string)
$message: value (string), change it to the message you want to define
2013-11-28 09:43:00 +00:00
'MessageCache::get': When fetching a message. Can be used to override the key
for customisations. Given and returned message key must be in special format:
1) first letter must be in lower case according to the content language.
2) spaces must be replaced with underscores
&$key: message key (string)
2013-01-04 20:33:37 +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.
2013-01-04 20:33:37 +00:00
'MonoBookTemplateToolboxEnd': DEPRECATED. Called by Monobook skin after toolbox
links have been rendered (useful for adding more). Note: this is only run for
the Monobook skin. To add items to the toolbox you should use the
SkinTemplateToolboxEnd hook instead, which works for all "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
2013-01-04 20:33:37 +00:00
BaseTemplate::makeListItem for details on the format of individual items
inside of this array.
2010-12-06 17:47:53 +00:00
2013-01-04 20:33:37 +00:00
'NamespaceIsMovable': Called when determining if it is possible to pages in a
namespace.
2012-05-10 10:19:56 +00:00
$index: Integer; the index of the namespace being checked.
2013-01-04 20:33:37 +00:00
$result: Boolean; whether MediaWiki currently thinks that pages in this
namespace are movable. Hooks may change this value to override the return
value of MWNamespace::isMovable().
2012-05-10 10:19:56 +00:00
2013-01-04 20:33:37 +00:00
'NewRevisionFromEditComplete': Called when a revision was inserted due to an
edit.
2012-12-05 13:41:41 +00:00
$wikiPage: 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
2013-01-04 20:33:37 +00:00
displayed.
2009-05-28 17:05:09 +00:00
&$key: the message being looked up. Change this to something else to change
2013-01-04 20:33:37 +00:00
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 -
2013-01-04 20:33:37 +00:00
whether to use the content language (true) or site language (false) (bool)
2009-05-28 17:05:09 +00:00
&$transform: whether or not to expand variables and templates
2013-01-04 20:33:37 +00:00
in the message (bool)
2008-07-07 22:37:42 +00:00
2013-01-04 20:33:37 +00:00
'OldChangesListRecentChangesLine': Customize entire recent changes line, or
return false to omit the line from RecentChanges and Watchlist special pages.
2008-09-03 22:13:03 +00:00
&$changeslist: The OldChangesList instance.
&$s: HTML of the form "<li>...</li>" containing one RC entry.
&$rc: The RecentChange object.
2013-01-10 15:52:30 +00:00
&$classes: array of css classes for the <li> element
2008-09-03 22:13:03 +00:00
2013-01-04 20:33:37 +00:00
'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
can alter or append to the array of URLs for search & suggestion formats.
2008-07-01 23:31:24 +00:00
&$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
2013-01-04 20:33:37 +00:00
users and/or IP addresses too.
2009-12-30 08:51:25 +00:00
$otherBlockLink: An array with links to other block logs
$ip: The requested IP address or username
2013-01-04 20:33:37 +00:00
'OutputPageBeforeHTML': A page has been processed by the parser and the
resulting HTML is about to be displayed.
2009-06-18 02:13:42 +00:00
$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)
2013-01-04 20:33:37 +00:00
'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
body 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.
2010-10-03 14:12:41 +00:00
$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
2013-01-04 20:33:37 +00:00
since the last visit.
2009-05-28 17:05:09 +00:00
&$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
2013-01-04 20:33:37 +00:00
'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2009-05-28 17:05:09 +00:00
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
2013-01-04 20:33:37 +00:00
types ("normal" or "hidden")
2009-05-28 17:05:09 +00:00
$links: array, intended to hold the result. Must be an associative array with
2013-01-04 20:33:37 +00:00
category types as keys and arrays of HTML links as values.
2008-07-02 20:02:51 +00:00
2013-01-04 20:33:37 +00:00
'PageContentInsertComplete': After a new article is created.
2012-12-05 13:41:41 +00:00
$wikiPage: WikiPage created
2012-10-12 06:15:13 +00:00
$user: User creating the article
$content: New content as a Content object
$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 WikiPage::doEditContent()
$revision: New Revision of the article
2013-01-04 20:33:37 +00:00
'PageContentLanguage': Allows changing the language in which the content of a
page is written. Defaults to the wiki content language ($wgContLang).
2011-08-11 14:52:57 +00:00
$title: Title object
&$pageLang: the page content language (either an object or a language code)
$wgLang: the user language
2013-01-04 20:33:37 +00:00
'PageContentSave': Before an article is saved.
2012-12-05 13:41:41 +00:00
$wikiPage: the WikiPage (object) being saved
2012-10-12 06:15:13 +00:00
$user: the user (object) saving the article
$content: the new article content, as a Content object
$summary: the article summary (comment)
$isminor: minor flag
$iswatch: watch flag
$section: section #
2013-01-04 20:33:37 +00:00
'PageContentSaveComplete': After an article has been updated.
2012-12-05 13:41:41 +00:00
$wikiPage: WikiPage modified
2012-10-12 06:15:13 +00:00
$user: User performing the modification
$content: New content, as a Content object
$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 WikiPage::doEditContent()
2014-03-07 23:54:49 +00:00
$revision: New Revision of the article (can be null for edits that change nothing)
2012-10-12 06:15:13 +00:00
$status: Status object about to be returned by doEditContent()
$baseRevId: the rev ID (or false) this edit was based on
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
2013-03-13 16:54:23 +00:00
$context: RequestContext object
2007-03-25 23:20:48 +00:00
2013-11-13 05:41:04 +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
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'PageRenderingHash': Alter the parser cache option hash key. A parser extension
which depends on user options should install this hook and append its values to
the key.
2014-01-03 17:05:24 +00:00
&$confstr: reference to a hash key string which can be modified
$user: User (object) requesting the page
2005-12-25 11:04:40 +00:00
2012-06-17 00:34:36 +00:00
'ParserAfterParse': Called from Parser::parse() just after the call to
2013-01-04 20:33:37 +00:00
Parser::internalParse() returns.
2012-06-17 00:34:36 +00:00
$parser: parser object
$text: text being parsed
$stripState: stripState used (object)
2013-01-04 20:33:37 +00:00
'ParserAfterStrip': Called at end of parsing time.
TODO: No more strip, deprecated ?
$parser: parser object
$text: text being parsed
$stripState: stripState used (object)
2007-12-03 19:47:11 +00:00
'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2009-06-18 02:13:42 +00:00
$parser: Parser object being used
2013-01-27 17:59:24 +00:00
$text: text that will be returned
2007-12-03 19:47:11 +00:00
2013-01-04 20:33:37 +00:00
'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2007-12-03 19:47:11 +00:00
$parser: Parser object
$text: text to parse
$stripState: StripState instance being used
2013-01-04 20:33:37 +00:00
'ParserBeforeStrip': Called at start of parsing time.
TODO: No more strip, deprecated ?
2007-12-03 19:47:11 +00:00
$parser: parser object
$text: text being parsed
$stripState: stripState used (object)
2013-01-04 20:33:37 +00:00
'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
2013-01-04 20:33:37 +00:00
'ParserClearState': Called at the end of Parser::clearState().
2007-12-03 19:47:11 +00:00
$parser: Parser object being cleared
2013-01-04 20:33:37 +00:00
'ParserCloned': Called when the parser is cloned.
2012-11-15 00:05:24 +00:00
$parser: Newly-cloned Parser object
2013-01-04 20:33:37 +00:00
'ParserFirstCallInit': Called when the parser initialises for the first time.
2008-03-01 20:39:45 +00:00
&$parser: Parser object being cleared
2008-02-10 11:39:39 +00:00
2013-01-04 20:33:37 +00:00
'ParserGetVariableValueSwitch': Called when the parser need the value of a
2009-05-28 17:05:09 +00:00
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
2013-01-04 20:33:37 +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)
2013-01-04 20:33:37 +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
2013-01-27 17:59:24 +00:00
$varCache: variable cache (array)
2007-12-03 19:47:11 +00:00
2013-03-14 12:43:06 +00:00
'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
ParserLimitReportFormat instead.
Called at the end of Parser:parse() when the parser will
2013-01-04 20:33:37 +00:00
include comments about size of the text parsed.
2007-12-03 19:47:11 +00:00
$parser: Parser object
2013-03-14 12:43:06 +00:00
&$limitReport: text that will be included (without comment tags)
'ParserLimitReportFormat': Called for each row in the parser limit report that
needs formatting. If nothing handles this hook, the default is to use "$key" to
get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
format the value.
$key: Key for the limit report item (string)
2013-08-22 17:47:23 +00:00
&$value: Value of the limit report item
2013-03-14 12:43:06 +00:00
&$report: String onto which to append the data
$isHTML: If true, $report is an HTML table with two columns; if false, it's
text intended for display in a monospaced font.
$localize: If false, $report should be output in English.
'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
include comments about size of the text parsed. Hooks should use
2013-08-22 17:47:23 +00:00
$output->setLimitReportData() to populate data. Functions for this hook should
not use $wgLang; do that in ParserLimitReportFormat instead.
2013-03-14 12:43:06 +00:00
$parser: Parser object
$output: ParserOutput object
2007-12-03 19:47:11 +00:00
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
2012-03-09 18:32:03 +00:00
$parser: Parser object that called the hook
2008-02-29 19:58:50 +00:00
2011-07-20 17:08:37 +00:00
'ParserSectionCreate': Called each time the parser creates a document section
2013-01-04 20:33:37 +00:00
from wikitext. Use this to apply per-section modifications to HTML (like
2011-07-20 17:08:37 +00:00
wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2013-01-04 20:33:37 +00:00
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
2013-01-04 20:33:37 +00:00
'ParserTestParser': Called when creating a new instance of Parser in
2013-08-06 15:53:27 +00:00
tests/parser/parserTest.inc.
2007-12-03 19:47:11 +00:00
$parser: Parser object created
2012-08-20 14:55:28 +00:00
'ParserTestGlobals': Allows to define globals for parser tests.
&$globals: Array with all the globals which should be set for parser tests.
2013-01-04 20:33:37 +00:00
The arrays keys serve as the globals names, its values are the globals values.
2012-08-20 14:55:28 +00:00
2013-01-04 20:33:37 +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.
2007-02-09 05:37:44 +00:00
&$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
2013-12-09 05:59:16 +00:00
$skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
2006-05-08 22:20:55 +00:00
2013-01-04 20:33:37 +00:00
'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2006-12-22 20:21:14 +00:00
&$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.
2013-09-20 22:26:08 +00:00
$incrBy: Amount to increment counter by
2006-12-22 20:21:14 +00:00
2013-01-04 20:33:37 +00:00
'PlaceNewSection': Override placement of new sections. Return false and put the
merged text into $text to override the default behavior.
2011-10-27 23:55:29 +00:00
$wikipage : WikiPage object
$oldtext : the text of the article before editing
$subject : subject of the new section
&$text : text of the new section
2014-05-28 20:29:32 +00:00
'PostLoginRedirect': Modify the post login redirect behavior.
Occurs after signing up or logging in, allows for interception of redirect.
&$returnTo: The page name to return to, as a string
&$returnToQuery: array of url parameters, mapping parameter names to values
&$type: type of login redirect as string;
error: display a return to link ignoring $wgRedirectOnLogin
signup: display a return to link using $wgRedirectOnLogin if needed
success: display a return to link using $wgRedirectOnLogin if needed
successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2013-01-04 20:33:37 +00:00
'PreferencesGetLegend': Override the text used for the <legend> of a
preferences section.
2011-10-31 13:19:38 +00:00
$form: the PreferencesForm object. This is a ContextSource as well
2011-10-31 12:36:51 +00:00
$key: the section name
2012-08-29 08:07:10 +00:00
&$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
2011-10-31 12:36:51 +00:00
2013-12-07 02:37:32 +00:00
'PreferencesFormPreSave': Override preferences being saved
$formData: array of user submitted data
$form: PreferencesForm object, also a ContextSource
$user: User object with preferences to be saved set
&$result: boolean indicating success
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)
2013-01-04 20:33:37 +00:00
'PrefsEmailAudit': Called when user changes their email address.
2007-12-03 19:47:11 +00:00
$user: User (object) changing his email address
$oldaddr: old email address (string)
$newaddr: new email address (string)
2013-01-04 20:33:37 +00:00
'PrefsPasswordAudit': Called when user changes his password.
2013-01-27 17:59:24 +00:00
$user: User (object) changing his password
2007-12-03 19:47:11 +00:00
$newPass: new password
$error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2013-01-04 20:33:37 +00:00
'ProtectionForm::buildForm': Called after all protection type fieldsets are made
in the form.
2009-10-02 18:46:19 +00:00
$article: the title being (un)protected
$output: a string of the form HTML so far
2013-01-04 20:33:37 +00:00
'ProtectionForm::save': Called when a protection form is submitted.
2013-05-20 19:18:21 +00:00
$article: the Page being (un)protected
&$errorMsg: an html message string of an error or an array of message name and
2013-01-04 20:33:37 +00:00
its parameters
2013-05-20 19:18:21 +00:00
$reasonstr: a string describing the reason page protection level is altered
2009-10-02 18:46:19 +00:00
2013-01-04 20:33:37 +00:00
'ProtectionForm::showLogExtract': Called after the protection log extract is
shown.
2009-10-02 18:47:38 +00:00
$article: the page the form is shown for
$out: OutputPage object
2013-01-04 20:33:37 +00:00
'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2014-06-23 18:28:47 +00:00
&$obj: RawAction object
2007-01-11 14:50:34 +00:00
&$text: The text that's going to be the output
2013-01-04 20:33:37 +00:00
'RecentChange_save': Called at the end of RecentChange::save().
2007-12-03 19:47:11 +00:00
$recentChange: RecentChange object
2013-01-04 20:33:37 +00:00
'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
names such as "oldid" that are preserved when using redirecting special pages
such as Special:MyPage and Special:MyTalk.
2012-05-10 03:12:42 +00:00
&$redirectParams: An array of parameters preserved by redirecting special pages.
2013-01-04 20:33:37 +00:00
'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
instance. Can be used by an extension override what skin is used in certain
contexts.
2012-01-03 01:58:27 +00:00
IContextSource $context: The RequestContext the skin is being created for.
2013-01-04 20:33:37 +00:00
&$skin: A variable reference you may set a Skin instance or string key on to
override the skin that will be used for the context.
2012-01-03 01:58:27 +00:00
Password Expiration
Add functionality to expire users' passwords:
* Adds column to the user table to keep a password expiration
* Adds $wgPasswordExpirationDays, which will force users to reset
their passwords after a set number of days. By default, this set
to false, so passwords never expire.
* Adds a default grace period of 7 days, where if the user's password
is expired, they can still login, but are encouraged to reset their
password.
* Adds hook 'LoginPasswordResetMessage' to update reset message, in
case an extension wants to vary the message on a particular reset
event.
* Adds hook 'ResetPasswordExpiration' to allow extensions to change
the expiration date when the user resets their password. E.g., if
an extension wants to vary the expiration based on the user's group.
If the user is in the grace period, they get a password reset form
added to the login successful page. If an extension prevents showing
the login successful page (like CentralAuth), it should be updated to
show a password change form during the grace period. After the grace
period, the user will not be able to login without changing their
password.
Also prevents a successful reset if the user is "changing" their
password to their existing password.
No passwords will expire by default. Sites will have to call
User->expirePassword() from their own maintenance script to trigger a
password reset for a user.
Bug: 54997
Change-Id: I92a9fc63b409b182b1d7b48781d73fc7216f8061
2013-10-09 18:09:28 +00:00
'ResetPasswordExpiration': Allow extensions to set a default password expiration
$user: The user having their password expiration reset
&$newExpire: The new expiration date
2013-08-07 16:21:22 +00:00
'ResetSessionID': Called from wfResetSessionID
$oldSessionID: old session id
$newSessionID: new session id
2013-01-04 20:33:37 +00:00
'ResourceLoaderGetConfigVars': Called at the end of
2011-01-09 11:44:52 +00:00
ResourceLoaderStartUpModule::getConfig(). Use this to export static
2013-01-04 20:33:37 +00:00
configuration variables to JavaScript. Things that depend on the current page
or request state must be added through MakeGlobalVariablesScript instead.
2011-01-09 11:44:52 +00:00
&$vars: array( variable name => value )
2014-04-20 21:01:21 +00:00
'ResourceLoaderGetStartupModules': DEPRECATED. Run once the startup module is being
2013-01-04 20:33:37 +00:00
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
2011-11-20 15:16:54 +00:00
scripts.
2011-10-08 09:07:02 +00:00
2013-01-04 20:33:37 +00:00
'ResourceLoaderRegisterModules': Right before modules information is required,
such as when responding to a resource
2011-10-08 09:07:02 +00:00
loader request or generating HTML output.
&$resourceLoader: ResourceLoader object
2013-01-04 20:33:37 +00:00
'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
called after the addition of 'qunit' and MediaWiki testing resources.
&testModules: array of JavaScript testing modules. The 'qunit' framework,
included in core, is fed using tests/qunit/QUnitTestResources.php.
2012-01-04 08:29:58 +00:00
&ResourceLoader object
2013-01-04 20:33:37 +00:00
2012-01-03 18:33:26 +00:00
To add a new qunit module named 'myext.tests':
testModules['qunit']['myext.tests'] = array(
'script' => 'extension/myext/tests.js',
'dependencies' => <any module dependency you might have>
);
2013-01-04 20:33:37 +00:00
For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
added to any module.
2012-01-03 18:33:26 +00:00
2013-01-04 20:33:37 +00:00
'RevisionInsertComplete': Called after a revision is inserted into the database.
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
2013-01-04 20:33:37 +00:00
'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
the normal operations.
2010-01-16 23:27:55 +00:00
$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
2012-11-02 16:56:36 +00:00
'SearchAfterNoDirectMatch': If there was no match for the exact result. This
runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
runs after.
$term : Search term string
&$title : Outparam; set to $title object and return false for a match
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
searches.
2010-01-16 23:27:55 +00:00
$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
2012-09-05 02:21:09 +00:00
'SearchResultInitFromTitle': Set the revision used when displaying a page in
search results.
$title : Current Title object being displayed in search results.
&$id: Revision ID (default is false, for latest)
2010-01-16 23:27:55 +00:00
'SearchableNamespaces': An option to modify which namespaces are searchable.
&$arr : Array of namespaces ($nsId => $name) which will be used.
2014-04-06 02:06:43 +00:00
'SelfLinkBegin': Called before a link to the current article is displayed to
allow the display of the link to be customized.
$nt: the Title object
&$html: html to display for the link
&$trail: optional text to display before $html
&$prefix: optional text to display after $html
&$ret: the value to return if your hook returns false
2008-12-11 11:50:45 +00:00
'SetupAfterCache': Called in Setup.php, after cache objects are set
2013-01-04 20:33:37 +00:00
'ShowMissingArticle': Called when generating the output for a non-existent page.
2009-09-14 18:10:13 +00:00
$article: The article object corresponding to the page
2012-04-26 13:12:40 +00:00
'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2012-10-16 10:38:20 +00:00
DEPRECATED, use the ContentGetParserOutput hook instead!
2007-08-28 21:53:50 +00:00
$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.
2012-11-06 13:01:16 +00:00
'ShowSearchHit': Customize display of search hit.
$searchPage: The SpecialSearch instance.
$result: The SearchResult to show
$terms: Search terms, for highlighting
&$link: HTML of link to the matching page. May be modified.
&$redirect: HTML of redirect info. May be modified.
&$section: HTML of matching section. May be modified.
&$extract: HTML of content extract. May be modified.
&$score: HTML of score. May be modified.
&$size: HTML of page size. May be modified.
&$date: HTML of of page modification date. May be modified.
&$related: HTML of additional info for the matching page. May be modified.
2013-01-04 20:33:37 +00:00
&$html: May be set to the full HTML that should be used to represent the search
hit. Must include the <li> ... </li> tags. Will only be used if the hook
function returned false.
2012-11-06 13:01:16 +00:00
2013-01-04 20:33:37 +00:00
'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. 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.
2006-06-04 16:55:19 +00:00
&$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
2013-01-04 20:33:37 +00:00
'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
&$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
the sitenotice/anonnotice.
2011-02-12 21:24:05 +00:00
$skin: Skin object
2006-06-04 16:55:19 +00:00
2013-01-04 20:33:37 +00:00
'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2007-08-23 22:34:12 +00:00
$skin: Skin object
2013-01-04 20:33:37 +00:00
&$text: bottomScripts Text. Append to $text to add additional text/scripts after
the stock bottom scripts.
2007-08-23 22:34:12 +00:00
2008-08-08 15:53:49 +00:00
'SkinAfterContent': Allows extensions to add text after the page content and
2013-01-04 20:33:37 +00:00
article metadata. This hook should work in all skins. Set the &$data variable to
the text you're going to add.
2008-08-08 15:53:49 +00:00
&$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
2013-01-04 20:33:37 +00:00
'SkinBuildSidebar': At the end of Skin::buildSidebar().
2008-08-01 14:40:05 +00:00
$skin: Skin object
&$bar: Sidebar contents
Modify $bar to add or modify sidebar portlets.
2014-05-09 11:57:16 +00:00
'SidebarBeforeOutput': Allows to edit sidebar just before its output by skins.
$skin Skin object
&$bar: Sidebar content
Modify $bar to add or modify sidebar portlets.
Warning: This hook is run on each display. You should consider to use 'SkinBuildSidebar' that is aggressively cached.
2013-01-04 20:33:37 +00:00
'SkinCopyrightFooter': Allow for site and per-namespace customization of
copyright notice.
2009-06-24 16:49:28 +00:00
$title: displayed page title
$type: 'normal' or 'history' for old/diff views
2013-01-04 20:33:37 +00:00
&$msg: overridable message; usually 'copyright' or 'history_copyright'. This
message must be in HTML format, not wikitext!
2009-06-24 16:49:28 +00:00
&$link: overridable HTML link to be passed into the message as $1
2011-11-20 15:16:54 +00:00
&$forContent: overridable flag if copyright footer is shown in content language.
2014-03-24 22:57:59 +00:00
This parameter is deprecated.
2009-06-24 16:49:28 +00:00
2013-01-04 20:33:37 +00:00
'SkinGetPoweredBy': TODO
&$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
2013-01-04 20:33:37 +00:00
'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2008-01-29 15:05:48 +00:00
&$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
2013-01-04 20:33:37 +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
2014-02-03 20:58:53 +00:00
'SkinTemplateGetLanguageLink': After building the data for a language link from
which the actual html is constructed.
&$languageLink: array containing data about the link. The following keys can be
modified: href, text, title, class, lang, hreflang. Each of them is a string.
$languageLinkTitle: Title object belonging to the external language link
$title: Title object of the page the link belongs to
2013-01-04 20:33:37 +00:00
To alter the structured navigation links in SkinTemplates, there are three
hooks called in different spots:
'SkinTemplateNavigation': Called on content pages after the tabs have been
added, but before variants have been added.
'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
tab is added but before variants have been added.
'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
2013-01-04 20:33:37 +00:00
&$links: Structured navigation links. This is used to alter the navigation for
skins which use buildNavigationUrls such as Vector.
2009-07-06 21:22:40 +00:00
2013-01-04 20:33:37 +00:00
'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
page output.
2007-01-10 15:23:32 +00:00
&$sktemplate: SkinTemplate object
&$tpl: Template engine object
2013-01-04 20:33:37 +00:00
'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2007-12-03 19:47:11 +00:00
$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.
2013-01-04 16:00:48 +00:00
2009-05-28 17:05:09 +00:00
'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2013-01-04 20:33:37 +00:00
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,
2013-01-04 20:33:37 +00:00
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
2013-12-15 16:24:03 +00:00
'SkinVectorStyleModules': Called when defining the list of module styles to be
loaded by the Vector skin.
$skin: SkinVector object
&$styles: Array of module names whose style will be loaded for the skin
2013-01-04 20:33:37 +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
2013-12-12 20:18:05 +00:00
'SpecialBlockModifyFormFields': Add more fields to Special:Block
$sp: SpecialPage object, for context
&$fields: Current HTMLForm fields
2007-07-16 11:30:27 +00:00
'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2013-12-21 07:50:57 +00:00
$id: User id number, only provided for backwards-compatability
$user: User object representing user contributions are being fetched for
$sp: SpecialPage instance, providing context
2007-07-16 07:11:25 +00:00
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'SpecialListusersQueryInfo': Called right before the end of.
2009-05-28 17:05:09 +00:00
UsersPager::getQueryInfo()
2008-03-02 14:14:43 +00:00
$pager: The UsersPager instance
$query: The query array to be returned
2013-01-04 20:33:37 +00:00
'SpecialMovepageAfterMove': Called after moving a page.
2007-12-03 19:47:11 +00:00
$movePage: MovePageForm object
$oldTitle: old title (object)
$newTitle: new title (object)
2013-01-04 20:33:37 +00:00
'SpecialNewpagesConditions': Called when building sql query for
Special:NewPages.
2010-04-24 11:05:15 +00:00
&$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
2013-01-04 20:33:37 +00:00
'SpecialNewPagesFilters': Called after building form options at NewPages.
2011-05-23 04:28:58 +00:00
$special: the special page object
2013-01-04 20:33:37 +00:00
&$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
2013-11-21 18:27:21 +00:00
'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2013-01-04 20:33:37 +00:00
hook to remove a core special page.
2007-12-03 19:47:11 +00:00
$list: list (array) of core special pages
2013-01-04 20:33:37 +00:00
'SpecialPageAfterExecute': Called after SpecialPage::execute.
2012-07-06 11:36:01 +00:00
$special: the SpecialPage object
$subPage: the subpage string or null if no subpage was specified
2013-01-04 20:33:37 +00:00
'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2012-07-06 11:36:01 +00:00
$special: the SpecialPage object
$subPage: the subpage string or null if no subpage was specified
2013-01-04 20:33:37 +00:00
'SpecialPasswordResetOnSubmit': When executing a form submission on
Special:PasswordReset.
$users: array of User objects.
2011-06-13 14:55:03 +00:00
$data: array of data submitted by the user
2013-01-04 20:33:37 +00:00
&$error: string, error code (message key) used to describe to error (out
parameter). The hook needs to return false when setting this, otherwise it
will have no effect.
2011-06-13 14:55:03 +00:00
2013-01-04 20:33:37 +00:00
'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
use this to change some selection criteria or substitute a different title.
2009-08-17 15:23:51 +00:00
&$randstr: The random number from wfRandom()
2011-11-20 15:16:54 +00:00
&$isRedir: Boolean, whether to select a redirect or non-redirect
2009-08-17 15:23:51 +00:00
&$namespaces: An array of namespace indexes to get the title from
2011-11-20 15:16:54 +00:00
&$extra: An array of extra SQL statements
2009-08-17 15:23:51 +00:00
&$title: If the hook returns false, a Title object to use instead of the
2013-01-04 20:33:37 +00:00
result from the normal query
2009-08-17 15:23:51 +00:00
2013-01-04 20:33:37 +00:00
'SpecialRecentChangesFilters': Called after building form options at
2014-01-08 17:17:08 +00:00
RecentChanges. Deprecated, use ChangesListSpecialPageFilters instead.
2011-05-23 04:28:58 +00:00
$special: the special page object
2013-01-04 20:33:37 +00:00
&$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.
2011-05-23 04:28:58 +00:00
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'SpecialRecentChangesQuery': Called when building SQL query for
2014-01-08 17:17:08 +00:00
SpecialRecentChanges and SpecialRecentChangesLinked. Deprecated, use
ChangesListSpecialPageQuery instead.
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
Refactor watchlist token handling
Do not allow the user to change it directly; instead create a form
where they can reset it. (The token can still be changed via the API.)
The token is autogenerated whenever it is shown or otherwise used.
This really should have never used the preferences; however, trying to
change that now would be lots of work for very little gain, so this
keeps using that mechanism, adding a little abstraction over it.
It's not unconceivable that similar tokens could be used for other
pieces of data, like Echo's notifications; this enables that with one
new hook.
----
Things done here:
* Add getTokenFromOption() and resetTokenFromOption() methods to User,
abstracting out the get-and-generate-if-empty process of handling
tokens. Respect $wgHiddenPrefs (Watchlist didn't do that
previously).
* Create Special:ResetTokens, inspired by Special:Preferences and
Special:ChangeEmail, presenting the token resetting interface
(HTMLForm-based with CSRF protection).
* Create a new hook, SpecialResetTokensTokens, allowing extensions to
register tokens to be shown in the resetting form. Each token needs
information about the preference it corresponds to and a short
description (used for checkbox label).
* Hide the preference on Special:Preferences (use type=api to achieve
this), display a link to aforementioned special page instead. Move
info blurb to its own section at the bottom.
Bug: 21912
Change-Id: I0bdd2469972c4af81bfb480e9dde58cdd14c67a8
2013-06-14 16:59:59 +00:00
'SpecialResetTokensTokens': Called when building token list for
SpecialResetTokens.
&$tokens: array of token information arrays in the format of
array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2013-01-04 20:33:37 +00:00
'SpecialSearchCreateLink': Called when making the message to create a page or
go to the existing page.
2011-09-15 16:26:35 +00:00
$t: title object searched for
&$params: an array of the default message name and page title (as parameter)
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
the advanced form, a.k.a. power search box.
2011-09-15 16:26:35 +00:00
&$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')
2013-01-04 20:33:37 +00:00
'SpecialSearchProfiles': Allows modification of search profiles.
2009-09-08 11:50:31 +00:00
&$profiles: profiles, which can be modified.
2013-01-04 20:33:37 +00:00
'SpecialSearchProfileForm': Allows modification of search profile forms.
2011-04-22 16:13:58 +00:00
$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
2013-01-04 20:33:37 +00:00
'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2013-01-07 18:00:05 +00:00
$search: SpecialSearch special page object
2011-04-22 16:13:58 +00:00
$profile: String: current search profile
$engine: the search engine
2013-01-18 00:46:40 +00:00
'SpecialSearchResultsPrepend': Called immediately before returning HTML
on the search results page. Useful for including an external search
provider. To disable the output of MediaWiki search output, return
false.
$specialSearch: SpecialSearch object ($this)
$output: $wgOut
$term: Search term specified by the user
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2011-11-20 15:16:54 +00:00
&$extraStats: Array to save the new stats
2013-01-04 20:33:37 +00:00
( $extraStats['<name of statistic>'] => <value>; )
2009-08-06 13:40:13 +00:00
2011-11-20 15:16:54 +00:00
'SpecialUploadComplete': Called after successfully uploading a file from
2013-01-04 20:33:37 +00:00
Special:Upload.
2009-10-23 20:05:31 +00:00
$form: The SpecialUpload object
2009-07-19 20:03:13 +00:00
2013-01-04 20:33:37 +00:00
'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2012-11-29 17:06:25 +00:00
$wgVersion: Current $wgVersion for you to use
&$versionUrl: Raw url to link to (eg: release notes)
2013-01-04 20:33:37 +00:00
'SpecialWatchlistFilters': Called after building form options at Watchlist.
2014-01-08 17:17:08 +00:00
Deprecated, use ChangesListSpecialPageFilters instead.
2011-05-23 04:28:58 +00:00
$special: the special page object
2013-01-04 20:33:37 +00:00
&$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.
2011-05-23 04:28:58 +00:00
2013-01-04 20:33:37 +00:00
'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2014-01-08 17:17:08 +00:00
Deprecated, use ChangesListSpecialPageQuery instead.
2008-12-21 21:31:06 +00:00
&$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
2013-10-11 19:39:00 +00:00
$opts: A FormOptions object with watchlist options for the current request
2008-12-21 21:31:06 +00:00
2013-10-15 22:21:34 +00:00
'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2013-11-10 10:07:58 +00:00
SpecialWatchlist. Allows extensions to register custom values they have
2013-10-15 22:21:34 +00:00
inserted to rc_type so they can be returned as part of the watchlist.
&$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2013-01-04 20:33:37 +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.
2011-09-19 23:14:52 +00:00
$request: WebRequest
$title: Title of the currently found title obj
$output: OutputPage object
2013-01-04 20:33:37 +00:00
'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
rendered (by ThumbnailImage:toHtml method).
2012-11-07 05:19:57 +00:00
$thumbnail: the ThumbnailImage object
2013-01-27 17:59:24 +00:00
&$attribs: image attribute array
2012-11-07 05:19:57 +00:00
&$linkAttribs: image link attribute array
2013-01-04 20:33:37 +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
2013-03-08 20:15:27 +00:00
'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
or override the quick permissions check.
$title: The Title object being accessed
$user: The User performing the action
$action: Action being performed
&$errors: Array of errors
$doExpensiveQueries: Whether to do expensive DB queries
$short: Whether to return immediately on first error
2013-07-24 00:28:47 +00:00
'TitleGetEditNotices': Allows extensions to add edit notices
$title: The Title object for the page the edit notices are for
$oldid: Revision ID that the edit notices are for (or 0 for latest)
&$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2009-11-09 12:05:30 +00:00
'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2013-01-04 20:33:37 +00:00
that can be applied.
2009-11-09 12:05:30 +00:00
$title: The title in question.
&$types: The types of protection available.
2013-01-04 20:33:37 +00:00
'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page.
2011-08-02 15:40:27 +00:00
$title: Title object that is being checked
2013-01-04 20:33:37 +00:00
$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().
'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2013-03-04 08:44:38 +00:00
overriding default behavior for determining if a page exists. If $isKnown is
2013-01-04 20:33:37 +00:00
kept as null, regular checks happen. If it's a boolean, this value is returned
by the isKnown method.
2012-02-09 14:10:59 +00:00
$title: Title object that is being checked
2012-11-06 19:52:30 +00:00
&$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2012-02-09 14:10:59 +00:00
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
$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-30 11:21:24 +00:00
2011-08-11 17:21:31 +00:00
'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2013-01-27 17:59:24 +00:00
be handled by separate handler (via ArticleViewCustom).
2011-08-11 17:21:31 +00:00
$title: Title object that is being checked
2013-01-04 20:33:37 +00:00
$result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
Hooks may change this value to override the return value of
Title::isWikitextPage()
2011-08-11 17:21:31 +00:00
2013-09-12 10:13:21 +00:00
'TitleMove': Before moving an article (title).
$old: old title
$nt: new title
$user: user who does the move
2013-01-04 20:33:37 +00:00
'TitleMoveComplete': After moving an article (title).
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
$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
2014-02-17 13:02:54 +00:00
$reason: reason for the move
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
2013-01-04 20:33:37 +00:00
'TitleReadWhitelist': Called at the end of read permissions checks, just before
adding the default error message if nothing allows the user to read the page. If
a handler wants a title to *not* be whitelisted, it should also return false.
2012-01-05 20:29:53 +00:00
$title: Title object being checked against
$user: Current user object
2012-01-06 06:16:05 +00:00
&$whitelisted: Boolean value of whether this title is whitelisted
2012-01-05 20:29:53 +00:00
2013-05-17 13:18:48 +00:00
'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2014-05-11 10:02:21 +00:00
$title: Title object to purge
2013-05-17 13:18:48 +00:00
&$urls: An array of URLs to purge from the caches, to be manipulated.
2013-01-04 20:33:37 +00:00
'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2011-05-16 13:30:32 +00:00
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
2013-01-04 20:33:37 +00:00
'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2011-05-16 13:30:32 +00:00
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
2013-01-04 20:33:37 +00:00
'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2011-05-16 13:30:32 +00:00
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
2013-01-04 20:33:37 +00:00
'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2007-12-03 19:47:11 +00:00
$title: title object related to the revision
$rev: revision (object) that will be viewed
2013-01-27 17:59:24 +00:00
'UnknownAction': An unknown "action" has occurred (useful for defining your own
2013-01-04 20:33:37 +00:00
actions).
2004-11-28 07:06:25 +00:00
$action: action name
$article: article "acted on"
2013-01-04 20:33:37 +00:00
'UnitTestsList': Called when building a list of files with PHPUnit tests.
2010-06-28 18:17:47 +00:00
&$files: list of files
2013-01-04 20:33:37 +00:00
'UnwatchArticle': Before a watch is removed from an article.
2004-11-30 05:45:56 +00:00
$user: user watching
2012-01-06 16:28:11 +00:00
$page: WikiPage object to be removed
2013-06-13 17:56:29 +00:00
&$status: Status object to be returned if the hook returns false
2004-11-30 05:45:56 +00:00
2013-01-04 20:33:37 +00:00
'UnwatchArticleComplete': After a watch is removed from an article.
2007-08-28 21:53:50 +00:00
$user: user that watched
2012-01-06 16:28:11 +00:00
$page: WikiPage object that was watched
2007-08-28 21:53:50 +00:00
2013-01-04 20:33:37 +00:00
'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2012-05-18 21:01:12 +00:00
$formattedPageStatus: list of valid page states
2013-01-04 20:33:37 +00:00
'UploadForm:initial': Before the upload form is generated. You might set the
member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
text (HTML) either before or after the editform.
2009-12-21 19:57:43 +00:00
$form: UploadForm object
2013-01-04 20:33:37 +00:00
'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
poke at member variables like $mUploadDescription before the file is saved. 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
$form: UploadForm object
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'UploadComplete': when Upload completes an upload.
2009-10-23 20:05:31 +00:00
&$upload: an UploadBase child instance
2013-01-04 20:33:37 +00:00
'UploadFormInitDescriptor': After the descriptor for the upload form as been
assembled.
2009-11-17 20:52:04 +00:00
$descriptor: (array) the HTMLForm descriptor
2009-10-23 20:05:31 +00:00
2011-11-20 15:16:54 +00:00
'UploadFormSourceDescriptors': after the standard source inputs have been
2009-10-23 20:05:31 +00:00
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
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
in most cases over UploadVerification.
2010-08-30 12:10:02 +00:00
object $upload: an instance of UploadBase, with all info about the upload
2013-01-04 20:33:37 +00:00
string $mime: The uploaded file's mime type, as detected by MediaWiki. Handlers
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
2013-01-04 20:33:37 +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.
2010-08-30 12:10:02 +00:00
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
$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
2013-01-04 20:33:37 +00:00
'UserAddGroup': Called when adding a group; return false to override
2011-03-16 23:13:38 +00:00
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
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'userCan': To interrupt/advise the "user can do X to Y article" check. 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,
2013-01-04 20:33:37 +00:00
userCan checks are continued by internal code.
2006-02-05 18:53:37 +00:00
2013-01-04 20:33:37 +00:00
'UserCanSendEmail': To override User::canSendEmail() permission check.
2008-01-29 00:31:26 +00:00
$user: User (object) whose permission is being checked
&$canSend: bool set on input, can override on output
2013-01-04 20:33:37 +00:00
'UserClearNewTalkNotification': Called when clearing the "You have new
messages!" message, return false to not delete it.
2013-01-27 17:59:24 +00:00
$user: User (object) that will clear the message
Correctly update wl_notificationtimestamp when viewing old revisions
== Prelude ==
wl_notificationtimestamp controls sending the user e-mail
notifications about changes to pages, as well as showing the "updated
since last visit" markers on history pages, recent changes and
watchlist.
== The bug ==
Previously, on every view of a page, the notification timestamp was
cleared, regardless of whether the user as actually viewing the latest
revision. When viewing a diff, however, the timestamp was cleared only
if one of the revisions being compared was the latest one of its page.
The same behavior applied to talk page message indicators (which are
actually stored sepately to cater to anonymous users).
This was inconsistent and surprising when one was attempting to, say,
go through the 50 new posts to a discussion page in a peacemeal
fashion.
== The fix ==
If the revision being viewed is the latest (or can't be determined),
the timestamp is cleared as previously, as this is necessary to
reenable e-mail notifications for given user and page.
If the revision isn't the latest, the timestamp is updated to
revision's timestamp plus one second. This uses up to two simple
(selectField) indexed queries per page view, only fired when we
do not already know we're looking at the latest version.
Talk page indicator is updated to point at the next revision after the
one being viewed, or cleared if viewing the latest revision. The
UserClearNewTalkNotification hook gained $oldid as the second argument
(a backwards-compatible change). In Skin, we no longer ignore the
indicator being present if we're viewing the talk page, as it might
still be valid.
== The bonus ==
Comments and formatting was updated in a few places, including
tables.sql and Wiki.php.
The following functions gained a second, optional $oldid parameter
(holy indirection, Batman!):
* WikiPage#doViewUpdates()
* User#clearNotification()
* WatchedItem#resetNotificationTimestamp()
DifferenceEngine gained a public method mapDiffPrevNext() used
to parse the ids from URL parameters like oldid=12345&diff=prev,
factored out of loadRevisionIds(). A bug where the NewDifferenceEngine
hook would not be called in some cases, dating back to its
introduction in r45518, was fixed in the process.
Bug: 41759
Change-Id: I4144ba1987b8d7a7e8b24f4f067eedac2ae44459
2013-09-16 10:31:40 +00:00
$oldid: ID of the talk page revision being viewed (0 means the most recent one)
2007-12-03 19:47:11 +00:00
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
supplied
2009-05-28 17:05:09 +00:00
&$result: If the hook returns false, this Boolean value will be checked to
2013-01-04 20:33:37 +00:00
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
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'UserEffectiveGroups': Called in User::getEffectiveGroups().
2007-12-03 19:47:11 +00:00
$user: User to get groups for
&$groups: Current effective groups
2013-01-04 20:33:37 +00:00
'UserGetAllRights': After calculating a list of all available rights.
2008-05-09 16:22:33 +00:00
&$rights: Array of rights, which may be added to.
2013-01-04 20:33:37 +00:00
'UserGetDefaultOptions': After fetching the core default, this hook is run right
before returning the options to the caller. Warning: This hook is called for
every call to User::getDefaultOptions(), which means it's potentially called
dozens or hundreds of times. You may want to cache the results of non-trivial
operations in your hook function for this reason.
2011-11-20 15:16:54 +00:00
&$defaultOptions: Array of preference keys and their default values.
2011-09-17 02:42:34 +00:00
2013-01-04 20:33:37 +00:00
'UserGetEmail': Called when getting an user email address.
2008-04-15 15:37:02 +00:00
$user: User object
&$email: email, change this to override local email
2013-01-04 20:33:37 +00:00
'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2013-01-27 17:59:24 +00:00
email authentication.
2008-04-15 15:37:02 +00:00
$user: User object
2013-01-27 17:59:24 +00:00
&$timestamp: timestamp, change this to override local email authentication
2013-01-04 20:33:37 +00:00
timestamp
2008-04-15 15:37:02 +00:00
2013-01-04 20:33:37 +00:00
'UserGetImplicitGroups': Called in User::getImplicitGroups().
2008-04-15 15:37:02 +00:00
&$groups: List of implicit (automatically-assigned) groups
2013-01-04 20:33:37 +00:00
'UserGetLanguageObject': Called when getting user's interface language object.
2011-03-06 21:05:18 +00:00
$user: User object
2013-01-27 17:59:24 +00:00
&$code: Language code that will be used to create the object
2013-01-16 09:47:06 +00:00
$context: RequestContext object
2011-03-06 21:05:18 +00:00
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'UserGetRights': Called in User::getRights().
2008-04-15 15:37:02 +00:00
$user: User to get rights for
&$rights: Current rights
2013-01-04 20:33:37 +00:00
'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
specific block exemptions).
2009-10-07 14:30:12 +00:00
$user: User in question
$title: Title of the page in question
&$blocked: Out-param, whether or not the user is blocked from that page.
2013-01-04 20:33:37 +00:00
&$allowUsertalk: If the user is blocked, whether or not the block allows users
to edit their own user talk pages.
2009-10-07 14:30:12 +00:00
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
2013-07-12 15:06:41 +00:00
'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
false if a UserGetRights hook might remove the named right.
$right: The user right being checked
2013-01-04 20:33:37 +00:00
'UserLoadAfterLoadFromSession': Called to authenticate users on external or
environmental means; occurs after session is loaded.
2009-04-24 01:31:17 +00:00
$user: user object being loaded
2013-01-04 20:33:37 +00:00
'UserLoadDefaults': Called when loading a default user.
2008-06-11 11:07:34 +00:00
$user: user object
$name: user name
2013-01-04 20:33:37 +00:00
'UserLoadFromDatabase': Called when loading a user from the database.
2009-01-16 23:34:38 +00:00
$user: user object
&$s: database query object
2013-01-04 20:33:37 +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
2013-01-27 17:59:24 +00:00
&$result: set this to a boolean value to abort the normal authentication
2013-01-04 20:33:37 +00:00
process
2008-10-13 19:00:54 +00:00
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'UserLoginComplete': After a user has logged in.
2004-11-27 23:10:05 +00:00
$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
2013-01-04 20:33:37 +00:00
'UserLogout': Before a user logs out.
2004-11-27 23:10:05 +00:00
$user: the user object that is about to be logged out
2009-06-18 02:13:42 +00:00
2013-01-04 20:33:37 +00:00
'UserLogoutComplete': After a user has logged out.
2004-11-27 23:10:05 +00:00
$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
2013-01-04 20:33:37 +00:00
'UserRemoveGroup': Called when removing a group; return false to override stock
group removal.
2011-03-16 23:13:38 +00:00
$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
2013-01-04 20:33:37 +00:00
'UserRights': After a user's group memberships are changed.
2006-03-29 02:31:15 +00:00
$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
2013-08-20 15:58:12 +00:00
'UserRequiresHTTPS': Called to determine whether a user needs
to be switched to HTTPS.
$user: User in question.
&$https: Boolean whether $user should be switched to HTTPS.
2013-01-04 20:33:37 +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)
2013-01-04 20:33:37 +00:00
'UserSaveSettings': Called when saving user settings.
2008-04-15 15:37:02 +00:00
$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
2013-01-04 20:33:37 +00:00
'UserSetCookies': Called when setting user cookies.
2008-06-11 11:07:34 +00:00
$user: User object
&$session: session array, will be added to $_SESSION
&$cookies: cookies array mapping cookie name to its value
2013-01-04 20:33:37 +00:00
'UserSetEmail': Called when changing user email address.
2008-04-15 15:37:02 +00:00
$user: User object
&$email: new email, change this to override new email address
2013-01-04 20:33:37 +00:00
'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
2013-01-27 17:59:24 +00:00
email authentication.
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
2013-01-27 17:59:24 +00:00
authentication timestamp
2008-04-15 15:37:02 +00:00
2013-01-04 20:33:37 +00:00
'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
"Foobar (Talk | Contribs | Block)".
2011-11-20 15:16:54 +00:00
$userId: User id of the current user
$userText: User name of the current user
2011-11-23 00:56:45 +00:00
&$items: Array of user tool links as HTML fragments
2011-11-20 15:16:54 +00:00
2013-08-12 16:18:29 +00:00
'ValidateExtendedMetadataCache': Called to validate the cached metadata in
FormatMetadata::getExtendedMeta (return false means cache will be
invalidated and GetExtendedMetadata hook called again).
$timestamp: The timestamp metadata was generated
$file: The file the metadata is for
2013-01-04 20:33:37 +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
2013-01-04 20:33:37 +00:00
'WatchArticle': Before a watch is added to an article.
2007-08-28 21:53:50 +00:00
$user: user that will watch
2012-01-06 16:28:11 +00:00
$page: WikiPage object to be watched
2013-06-13 17:56:29 +00:00
&$status: Status object to be returned if the hook returns false
2005-07-29 15:08:57 +00:00
2013-01-04 20:33:37 +00:00
'WatchArticleComplete': After a watch is added to an article.
2007-08-28 21:53:50 +00:00
$user: user that watched
2012-01-06 16:28:11 +00:00
$page: WikiPage object watched
2007-07-02 23:22:39 +00:00
2010-05-08 13:23:11 +00:00
'WatchlistEditorBuildRemoveLine': when building remove lines in
2013-01-04 20:33:37 +00:00
Special:Watchlist/edit.
2010-05-08 13:23:11 +00:00
&$tools: array of extra links
$title: Title object
$redirect: whether the page is a redirect
$skin: Skin object
2013-01-04 20:33:37 +00:00
'WebRequestPathInfoRouter': While building the PathRouter to parse the
REQUEST_URI.
2011-11-30 15:12:19 +00:00
$router: The PathRouter instance
2011-08-12 19:23:43 +00:00
2013-08-06 20:04:15 +00:00
'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
Return false to prevent setting of the cookie.
&$name: Cookie name passed to WebResponse::setcookie()
&$value: Cookie value passed to WebResponse::setcookie()
&$expire: Cookie expiration, as for PHP's setcookie()
$options: Options passed to WebResponse::setcookie()
2014-02-27 06:27:42 +00:00
'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
$row: The DB row of the entry.
$title: The Title of the page where the link comes FROM
$target: The Title of the page where the link goes TO
&$props: Array of HTML strings to display after the title.
2009-05-28 17:05:09 +00:00
'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2013-01-04 20:33:37 +00:00
dumps. One, and only one hook should set this, and return false.
2009-04-19 15:12:15 +00:00
&$tables: Database tables to use in the SELECT query
&$opts: Options to use for the query
&$join: Join conditions
2012-05-15 07:08:16 +00:00
'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
2013-01-04 20:33:37 +00:00
a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
specific to a content model should be provided by the respective Content's
getDeletionUpdates() method.
2012-05-15 07:08:16 +00:00
$page: the WikiPage
2012-07-24 15:51:28 +00:00
$content: the Content to generate updates for
2012-05-15 07:08:16 +00:00
&$updates: the array of DataUpdate objects. Hook function may want to add to it.
2013-01-04 20:33:37 +00:00
'wfShellWikiCmd': Called when generating a shell-escaped command line string to
run a MediaWiki cli script.
2012-04-04 23:48:55 +00:00
&$script: MediaWiki cli script path
2011-10-02 17:36:19 +00:00
&$parameters: Array of arguments and options to the script
&$options: Associative array of options, may contain the 'php' and 'wrapper'
2013-01-04 20:33:37 +00:00
keys
2011-10-02 17:36:19 +00:00
2014-02-04 19:50:11 +00:00
'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
to add new query pages to be updated with maintenance/updateSpecialPages.php.
$qp: The list of QueryPages
2007-01-21 16:46:36 +00:00
2013-01-04 20:33:37 +00:00
'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
extra metadata to be added.
2009-07-27 17:57:51 +00:00
$obj: The XmlDumpWriter object.
&$out: The output string.
$row: The database row for the page.
$title: The title of the page.
2013-01-04 20:33:37 +00:00
'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
add extra metadata.
2009-07-27 17:57:51 +00:00
$obj: The XmlDumpWriter object.
&$out: The text being output.
$row: The database row for the revision.
$text: The revision text.
2013-01-04 20:33:37 +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.
2011-04-16 01:23:15 +00:00
2013-01-04 20:33:37 +00:00
'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).
2011-04-16 01:23:15 +00:00
2006-05-02 20:59:56 +00:00
More hooks might be available but undocumented, you can execute
2013-11-13 07:24:27 +00:00
"php maintenance/findHooks.php" to find hidden ones.