2005-08-17 19:48:24 +00:00
|
|
|
hooks.txt
|
2004-11-27 21:43:06 +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.
|
|
|
|
|
|
|
|
|
|
==Glossary==
|
|
|
|
|
|
|
|
|
|
event
|
|
|
|
|
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'.
|
|
|
|
|
|
|
|
|
|
hook
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
hook function
|
|
|
|
|
The function part of a hook.
|
|
|
|
|
|
|
|
|
|
==Rationale==
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
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
|
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
|
|
|
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
|
|
|
|
2004-11-27 21:43:06 +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:
|
|
|
|
|
|
|
|
|
|
function showAnArticle($article) {
|
|
|
|
|
global $wgReverseTitle, $wgCapitalizeTitle;
|
|
|
|
|
|
|
|
|
|
if ($wgReverseTitle) {
|
|
|
|
|
wfReverseTitle($article);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if ($wgCapitalizeTitle) {
|
|
|
|
|
wfCapitalizeTitle($article);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# code to actually show the article goes here
|
|
|
|
|
|
|
|
|
|
if ($wgNotifyArticle) {
|
|
|
|
|
wfNotifyArticleShow($article));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Using a hook-running strategy, we can avoid having all this
|
|
|
|
|
option-specific stuff in our mainline code. Using hooks, the function
|
|
|
|
|
becomes:
|
|
|
|
|
|
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
|
|
|
}
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
In addition, we can take all the code that deals with the little-used
|
|
|
|
|
title-reversing options (say) and put it in one place. Instead of
|
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
|
|
|
having little title-reversing if-blocks spread all over the codebase
|
2004-11-27 21:43:06 +00:00
|
|
|
in showAnArticle, deleteAnArticle, exportArticle, etc., we can
|
|
|
|
|
concentrate it all in an extension file:
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
The setup function for the extension just has to add its hook
|
|
|
|
|
functions to the appropriate events:
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
If the code is well enough isolated, it can even be excluded when not
|
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
|
|
|
used -- making for some slight savings in memory and load-up
|
|
|
|
|
performance at runtime. Admins who want to have all the reversed
|
|
|
|
|
titles can add:
|
2004-11-27 21:43:06 +00:00
|
|
|
|
2007-06-18 15:37:10 +00:00
|
|
|
require_once('extensions/ReverseTitle.php');
|
|
|
|
|
|
2004-11-27 21:43:06 +00:00
|
|
|
...to their LocalSettings.php file; those of us who don't want or need
|
|
|
|
|
it can just leave it out.
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
==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.
|
|
|
|
|
|
|
|
|
|
Hooks are registered by adding them to the global $wgHooks array for a
|
|
|
|
|
given event. All the following are valid ways to define hooks:
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
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)
|
2004-11-27 21:43:06 +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.
|
|
|
|
|
|
|
|
|
|
The extra data is useful if we want to use the same function or object
|
|
|
|
|
for different purposes. For example:
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
This code would result in ircNotify being run twice when an article is
|
|
|
|
|
saved: once for 'TimStarling', and once for 'brion'.
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
* "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
|
|
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
2007-06-18 15:37:10 +00:00
|
|
|
$wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
|
|
|
|
|
|
|
|
|
|
function ldapLogin($username, $password) {
|
|
|
|
|
# log user into LDAP
|
|
|
|
|
return false;
|
|
|
|
|
}
|
2004-11-27 21:43:06 +00:00
|
|
|
|
|
|
|
|
Returning false makes less sense for events where the action is
|
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
|
|
|
complete, and will normally be ignored.
|
2004-11-27 21:43:06 +00:00
|
|
|
|
|
|
|
|
==Using hooks==
|
|
|
|
|
|
|
|
|
|
A calling function or method uses the wfRunHooks() function to run
|
|
|
|
|
the hooks related to a particular event, like so:
|
|
|
|
|
|
2007-06-18 15:37:10 +00:00
|
|
|
class Article {
|
|
|
|
|
# ...
|
|
|
|
|
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
|
|
|
}
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
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
|
|
|
|
|
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.
|
|
|
|
|
|
2004-11-27 23:10:05 +00:00
|
|
|
==Events and parameters==
|
|
|
|
|
|
|
|
|
|
This is a list of known events and parameters; please add to it if
|
|
|
|
|
you're going to add events to the MediaWiki code.
|
|
|
|
|
|
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
|
|
|
|
|
&$retval: a LoginForm class constant to return from authenticateUserData();
|
|
|
|
|
default is LoginForm::ABORTED. Note that the client may be using
|
|
|
|
|
a machine API rather than the HTML user interface.
|
|
|
|
|
|
2007-12-08 18:30:00 +00:00
|
|
|
'AbortMove': allows to abort moving an article (title)
|
|
|
|
|
$old: old title
|
|
|
|
|
$nt: new title
|
|
|
|
|
$user: user who is doing the move
|
|
|
|
|
$err: error message
|
|
|
|
|
|
2005-12-17 03:18:39 +00:00
|
|
|
'AbortNewAccount': Return false to cancel account creation.
|
|
|
|
|
$user: the User object about to be created (read-only, incomplete)
|
2006-01-29 07:35:28 +00:00
|
|
|
$message: out parameter: error message to display on abort
|
2005-12-17 03:18:39 +00:00
|
|
|
|
2005-08-17 07:44:38 +00:00
|
|
|
'AddNewAccount': after a user account is created
|
2006-04-17 04:06:13 +00:00
|
|
|
$user: the User object that was created. (Parameter added in 1.7)
|
2005-08-17 07:44:38 +00:00
|
|
|
|
2007-08-28 21:53:50 +00:00
|
|
|
'AjaxAddScript': Called in output page just before the initialisation
|
|
|
|
|
of the javascript ajax engine. The hook is only called when ajax
|
|
|
|
|
is enabled ( $wgUseAjax = true; ).
|
|
|
|
|
|
2007-05-19 21:45:07 +00:00
|
|
|
'AlternateEdit': before checking if an user can edit a page and
|
|
|
|
|
before showing the edit form ( EditPage::edit() ). This is triggered
|
|
|
|
|
on &action=edit.
|
|
|
|
|
$EditPage : the EditPage object
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'ArticleAfterFetchContent': after fetching content of an article from the database
|
|
|
|
|
$article: the article (object) being loaded from the database
|
|
|
|
|
$content: the content (string) of the article
|
|
|
|
|
|
2004-11-28 06:15:22 +00:00
|
|
|
'ArticleDelete': before an article is deleted
|
|
|
|
|
$article: the article (object) being deleted
|
|
|
|
|
$user: the user (object) deleting the article
|
|
|
|
|
$reason: the reason (string) the article is being deleted
|
|
|
|
|
|
|
|
|
|
'ArticleDeleteComplete': after an article is deleted
|
|
|
|
|
$article: the article that was deleted
|
|
|
|
|
$user: the user that deleted the article
|
|
|
|
|
$reason: the reason the article was deleted
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
|
|
|
|
|
$article: article (object) of the user talk page
|
|
|
|
|
|
|
|
|
|
'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
|
|
|
|
|
$article: article (object) being modified
|
|
|
|
|
|
|
|
|
|
'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
|
|
|
|
|
$title: title (object) used to create the article object
|
|
|
|
|
$article: article (object) that will be returned
|
|
|
|
|
|
2007-07-22 23:16:48 +00:00
|
|
|
'ArticleInsertComplete': After an article is created
|
|
|
|
|
$article: Article created
|
|
|
|
|
$user: User creating the article
|
|
|
|
|
$text: New content
|
|
|
|
|
$summary: Edit summary/comment
|
|
|
|
|
$isMinor: Whether or not the edit was marked as minor
|
|
|
|
|
$isWatch: (No longer used)
|
|
|
|
|
$section: (No longer used)
|
|
|
|
|
$flags: Flags passed to Article::doEdit()
|
|
|
|
|
$revision: New Revision of the article
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'ArticleMergeComplete': after merging to article using Special:Mergehistory
|
|
|
|
|
$targetTitle: target title (object)
|
|
|
|
|
$destTitle: destination title (object)
|
|
|
|
|
|
|
|
|
|
'ArticlePageDataAfter': after loading data of an article from the database
|
|
|
|
|
$article: article (object) whose data were loaded
|
|
|
|
|
$row: row (object) returned from the database server
|
|
|
|
|
|
|
|
|
|
'ArticlePageDataBefore': before loading data of an article from the database
|
|
|
|
|
$article: article (object) that data will be loaded
|
|
|
|
|
$fields: fileds (array) to load from the database
|
|
|
|
|
|
2004-11-28 00:20:37 +00:00
|
|
|
'ArticleProtect': before an article is protected
|
|
|
|
|
$article: the article being protected
|
|
|
|
|
$user: the user doing the protection
|
|
|
|
|
$protect: boolean whether this is a protect or an unprotect
|
|
|
|
|
$reason: Reason for protect
|
|
|
|
|
$moveonly: boolean whether this is for move only or not
|
|
|
|
|
|
|
|
|
|
'ArticleProtectComplete': after an article is protected
|
|
|
|
|
$article: the article that was protected
|
|
|
|
|
$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
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'ArticlePurge': before executing "&action=purge"
|
|
|
|
|
$article: article (object) to purge
|
|
|
|
|
|
2007-12-07 22:51:00 +00:00
|
|
|
'ArticleRevisionUndeleted' after an article revision is restored
|
|
|
|
|
$title: the article title
|
|
|
|
|
$revision: the revision
|
|
|
|
|
$oldPageID: the page ID of the revision when archived (may be null)
|
|
|
|
|
|
2007-10-30 07:58:15 +00:00
|
|
|
'ArticleRollbackComplete': after an article rollback is completed
|
|
|
|
|
$article: the article that was edited
|
|
|
|
|
$user: the user who did the rollback
|
|
|
|
|
$revision: the revision the page was reverted back to
|
|
|
|
|
|
2004-11-28 06:45:24 +00:00
|
|
|
'ArticleSave': before an article is saved
|
|
|
|
|
$article: the article (object) being saved
|
|
|
|
|
$user: the user (object) saving the article
|
|
|
|
|
$text: the new article text
|
|
|
|
|
$summary: the article summary (comment)
|
|
|
|
|
$isminor: minor flag
|
|
|
|
|
$iswatch: watch flag
|
|
|
|
|
$section: section #
|
|
|
|
|
|
2007-07-22 23:16:48 +00:00
|
|
|
'ArticleSaveComplete': After an article has been updated
|
|
|
|
|
$article: Article modified
|
|
|
|
|
$user: User performing the modification
|
|
|
|
|
$text: New content
|
|
|
|
|
$summary: Edit summary/comment
|
|
|
|
|
$isMinor: Whether or not the edit was marked as minor
|
|
|
|
|
$isWatch: (No longer used)
|
|
|
|
|
$section: (No longer used)
|
|
|
|
|
$flags: Flags passed to Article::doEdit()
|
|
|
|
|
$revision: New Revision of the article
|
|
|
|
|
|
2004-11-28 06:45:24 +00:00
|
|
|
'ArticleSaveComplete': after an article is saved
|
|
|
|
|
$article: the article (object) saved
|
|
|
|
|
$user: the user (object) who saved the article
|
|
|
|
|
$text: the new article text
|
|
|
|
|
$summary: the article summary (comment)
|
|
|
|
|
$isminor: minor flag
|
|
|
|
|
$iswatch: watch flag
|
|
|
|
|
$section: section #
|
|
|
|
|
|
2007-07-22 23:16:48 +00:00
|
|
|
wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'ArticleUndelete': When one or more revisions of an article are restored
|
2007-01-18 07:44:25 +00:00
|
|
|
$title: Title corresponding to the article restored
|
|
|
|
|
$create: Whether or not the restoration caused the page to be created
|
|
|
|
|
(i.e. it didn't exist before)
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
|
|
|
|
|
&$article: the article
|
|
|
|
|
&$sectionanchor: The section anchor link (e.g. "#overview" )
|
|
|
|
|
&$extraq: Extra query parameters which can be added via hooked functions
|
|
|
|
|
|
2007-06-03 22:34:53 +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
|
|
|
|
|
&$outputDone: whether the output for this page finished or not
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
|
|
|
|
|
$article: target article (object)
|
2007-08-15 22:13:03 +00:00
|
|
|
|
2006-11-30 07:47:34 +00:00
|
|
|
'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
|
|
|
|
|
Gives a chance for an extension to set it programattically to a variable class.
|
|
|
|
|
&$auth: the $wgAuth object, probably a stub
|
|
|
|
|
|
2005-12-20 21:25:54 +00:00
|
|
|
'AutoAuthenticate': called to authenticate users on external/environmental means
|
|
|
|
|
$user: writes user object to this parameter
|
|
|
|
|
|
2006-07-02 21:54:34 +00:00
|
|
|
'BadImage': When checking against the bad image list
|
|
|
|
|
$name: Image name being checked
|
|
|
|
|
&$bad: Whether or not the image is "bad"
|
|
|
|
|
|
|
|
|
|
Change $bad and return false to override. If an image is "bad", it is not
|
|
|
|
|
rendered inline in wiki pages or galleries in category pages.
|
|
|
|
|
|
2007-06-01 13:17:24 +00:00
|
|
|
'BeforeGalleryFindFile': before an image is fetched for a gallery
|
|
|
|
|
&$gallery,: the gallery object
|
|
|
|
|
&$nt: the image title
|
|
|
|
|
&$time: image timestamp
|
|
|
|
|
|
2007-08-28 21:53:50 +00:00
|
|
|
'BeforePageDisplay': Prior to outputting a page
|
|
|
|
|
$out: OutputPage object
|
|
|
|
|
|
2007-06-01 13:17:24 +00:00
|
|
|
'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
|
|
|
|
|
&$parser: Parser object
|
|
|
|
|
&$title: title of the template
|
|
|
|
|
&$skip: skip this template and link it?
|
|
|
|
|
&$id: the id of the revision being parsed
|
|
|
|
|
|
|
|
|
|
'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
|
|
|
|
|
&$parser: Parser object
|
|
|
|
|
&$nt: the image title
|
|
|
|
|
&$skip: skip this image and link it?
|
|
|
|
|
&$time: the image timestamp
|
|
|
|
|
|
|
|
|
|
'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
|
|
|
|
|
&$parser: Parser object
|
|
|
|
|
&$ig: ImageGallery object
|
|
|
|
|
|
2007-11-06 01:16:25 +00:00
|
|
|
'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
|
|
|
|
|
$nondefaults: Assoc array with the following keys:
|
|
|
|
|
days, hideOwn, hideBots, hideMinor, namespace
|
|
|
|
|
$wgUser: wgUser.
|
|
|
|
|
&$hookSql: a string which will be inserted without sanitation into the SQL query
|
|
|
|
|
used to get the watchlist, at the end of the WHERE part.
|
|
|
|
|
|
2004-11-27 23:57:55 +00:00
|
|
|
'BlockIp': before an IP address or user is blocked
|
|
|
|
|
$block: the Block object about to be saved
|
|
|
|
|
$user: the user _doing_ the block (not the one being blocked)
|
|
|
|
|
|
|
|
|
|
'BlockIpComplete': after an IP address or user is blocked
|
|
|
|
|
$block: the Block object that was saved
|
|
|
|
|
$user: the user who did the block (not the one being blocked)
|
|
|
|
|
|
2007-01-16 19:06:56 +00:00
|
|
|
'BookInformation': Before information output on Special:Booksources
|
|
|
|
|
$isbn: ISBN to show information for
|
|
|
|
|
$output: OutputPage object in use
|
|
|
|
|
|
2007-08-28 21:53:50 +00:00
|
|
|
'CategoryPageView': before viewing a categorypage in CategoryPage::view
|
|
|
|
|
$catpage: CategoryPage instance
|
|
|
|
|
|
2007-11-06 01:16:25 +00:00
|
|
|
'ChangesListInsertArticleLink': Override or augment link to article in RC list.
|
|
|
|
|
&$this: ChangesList instance.
|
|
|
|
|
&$articlelink: HTML of link to article (already filled-in).
|
|
|
|
|
&$s: HTML of row that is being constructed.
|
|
|
|
|
&$rc: RecentChange instance.
|
|
|
|
|
$unpatrolled: Whether or not we are showing unpatrolled changes.
|
|
|
|
|
$watched: Whether or not the change is watched by the user.
|
|
|
|
|
|
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.
|
|
|
|
|
|
2006-05-24 09:05:49 +00:00
|
|
|
'DiffViewHeader': called before diff display
|
|
|
|
|
$diff: DifferenceEngine object that's calling
|
|
|
|
|
$oldRev: Revision object of the "old" revision (may be null/invalid)
|
|
|
|
|
$newRev: Revision object of the "new" revision
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
|
|
|
|
|
$article: article (object) being viewed
|
|
|
|
|
$oldid: oldid (int) being viewed
|
|
|
|
|
|
2006-12-01 21:18:40 +00:00
|
|
|
'EditPage::attemptSave': called before an article is
|
|
|
|
|
saved, that is before insertNewArticle() is called
|
|
|
|
|
&$editpage_Obj: the current EditPage object
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'EditPage::showEditForm:initial': before showing the edit form
|
|
|
|
|
$editor: EditPage instance (object)
|
|
|
|
|
|
2006-06-14 13:12:08 +00:00
|
|
|
'EditFormPreloadText': Allows population of the edit form when creating new pages
|
|
|
|
|
&$text: Text to preload with
|
|
|
|
|
&$title: Title object representing the page being created
|
|
|
|
|
|
2007-04-02 21:53:06 +00:00
|
|
|
'EditPage::showEditForm:fields': allows injection of form field into edit form
|
|
|
|
|
&$editor: the EditPage instance for reference
|
|
|
|
|
&$out: an OutputPage instance to write to
|
|
|
|
|
return value is ignored (should always return true)
|
|
|
|
|
|
2006-05-06 21:41:53 +00:00
|
|
|
'EditFilter': Perform checks on an edit
|
|
|
|
|
$editor: Edit form (see includes/EditPage.php)
|
|
|
|
|
$text: Contents of the edit box
|
2006-05-07 07:26:25 +00:00
|
|
|
$section: Section being edited
|
|
|
|
|
&$error: Error message to return
|
2006-05-06 21:41:53 +00:00
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'EditFilterMerged': Post-section-merge edit filter
|
|
|
|
|
$editor: EditPage instance (object)
|
|
|
|
|
$text: content of the edit box
|
|
|
|
|
$error: error message to return
|
|
|
|
|
|
2006-05-06 21:41:53 +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
|
|
|
|
|
|
|
|
'EditSectionLink': Override the return value of Linker::editSectionLink()
|
|
|
|
|
$skin: Skin rendering the UI
|
|
|
|
|
$title: Title being linked to
|
|
|
|
|
$section: Section to link to
|
|
|
|
|
$link: Default link
|
|
|
|
|
$result: Result (alter this to override the generated links)
|
|
|
|
|
|
|
|
|
|
'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
|
|
|
|
|
$skin: Skin rendering the UI
|
|
|
|
|
$title: Title being linked to
|
|
|
|
|
$section: Section to link to
|
2007-06-05 12:54:13 +00:00
|
|
|
$hint: Anchor title/tooltip attributes
|
2007-06-05 01:50:33 +00:00
|
|
|
$link: Default link
|
|
|
|
|
$result: Result (alter this to override the generated links)
|
2006-05-06 21:41:53 +00:00
|
|
|
|
2006-05-02 20:07:54 +00:00
|
|
|
'EmailConfirmed': When checking that the user's email address is "confirmed"
|
|
|
|
|
$user: User being checked
|
|
|
|
|
$confirmed: Whether or not the email address is confirmed
|
|
|
|
|
This runs before the other checks, such as anonymity and the real check; return
|
|
|
|
|
true to allow those checks to occur, and false if checking is done.
|
|
|
|
|
|
2004-11-29 04:23:12 +00:00
|
|
|
'EmailUser': before sending email from one user to another
|
|
|
|
|
$to: address of receiving user
|
|
|
|
|
$from: address of sending user
|
|
|
|
|
$subject: subject of the mail
|
|
|
|
|
$text: text of the mail
|
|
|
|
|
|
|
|
|
|
'EmailUserComplete': after sending email from one user to another
|
|
|
|
|
$to: address of receiving user
|
|
|
|
|
$from: address of sending user
|
|
|
|
|
$subject: subject of the mail
|
|
|
|
|
$text: text of the mail
|
|
|
|
|
|
2006-06-21 00:18:55 +00:00
|
|
|
'FetchChangesList': When fetching the ChangesList derivative for a particular user
|
|
|
|
|
&$user: User the list is being fetched for
|
|
|
|
|
&$skin: Skin object to be used with the list
|
|
|
|
|
&$list: List object (defaults to NULL, change it to an object instance and return
|
|
|
|
|
false override the list derivative used)
|
|
|
|
|
|
2007-04-10 02:18:42 +00:00
|
|
|
'FileUpload': When a file upload occurs
|
|
|
|
|
$file : Image object representing the file that was uploaded
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'GetBlockedStatus': after loading blocking status of an user from the database
|
|
|
|
|
$user: user (object) being checked
|
|
|
|
|
|
2005-12-26 07:14:42 +00:00
|
|
|
'GetInternalURL': modify fully-qualified URLs used for squid cache purging
|
|
|
|
|
$title: Title object of page
|
|
|
|
|
$url: string value as output (out parameter, can modify)
|
|
|
|
|
$query: query options passed to Title::getInternalURL()
|
|
|
|
|
|
2007-11-22 15:54:18 +00:00
|
|
|
'GetLinkColours': modify the CSS class of an array of page links
|
|
|
|
|
$linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
|
|
|
|
|
&$colours: (output) array of CSS classes, indexed by prefixed DB keys
|
|
|
|
|
|
2005-12-26 07:14:42 +00:00
|
|
|
'GetLocalURL': modify local URLs as output into page links
|
|
|
|
|
$title: Title object of page
|
|
|
|
|
$url: string value as output (out parameter, can modify)
|
|
|
|
|
$query: query options passed to Title::getLocalURL()
|
|
|
|
|
|
|
|
|
|
'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
|
|
|
|
|
$title: Title object of page
|
|
|
|
|
$url: string value as output (out parameter, can modify)
|
|
|
|
|
$query: query options passed to Title::getFullURL()
|
|
|
|
|
|
2007-10-10 09:56:47 +00:00
|
|
|
'getUserPermissionsErrors': Add a permissions error when permissions errors are checked for.
|
|
|
|
|
Use instead of userCan for most cases. Return false if the user can't do it,
|
|
|
|
|
and populate $result with the reason in the form of array( messagename, param1, param2 )
|
|
|
|
|
$title: Title object being checked against
|
|
|
|
|
$user : Current user object
|
|
|
|
|
$action: Action being checked
|
|
|
|
|
$result: User permissions error to add. If none, return true.
|
|
|
|
|
|
2007-05-16 19:52:22 +00:00
|
|
|
'ImageOpenShowImageInlineBefore': Call potential extension just before showing the image on an image page
|
|
|
|
|
$imagePage: ImagePage object ($this)
|
|
|
|
|
$output: $wgOut
|
|
|
|
|
|
2007-07-30 22:52:37 +00:00
|
|
|
'InitPreferencesForm': called at the end of PreferencesForm's constructor
|
|
|
|
|
$form: the PreferencesForm
|
|
|
|
|
$request: the web request to initialized from
|
|
|
|
|
|
2007-04-25 21:23:43 +00:00
|
|
|
'InternalParseBeforeLinks': during Parser's internalParse method before links but
|
|
|
|
|
after noinclude/includeonly/onlyinclude and other processing.
|
|
|
|
|
&$this: Parser object
|
|
|
|
|
&$text: string containing partially parsed text
|
|
|
|
|
&$this->mStripState: Parser's internal StripState object
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
|
|
|
|
|
$article: article (object) being checked
|
|
|
|
|
|
|
|
|
|
'IsTrustedProxy': Override the result of wfIsTrustedProxy()
|
|
|
|
|
$ip: IP being check
|
|
|
|
|
$result: Change this value to override the result of wfIsTrustedProxy()
|
|
|
|
|
|
2007-10-21 17:15:37 +00:00
|
|
|
'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
|
|
|
|
|
tance to return false if the domain name doesn't match your organization
|
|
|
|
|
$addr: The e-mail address entered by the user
|
|
|
|
|
&$result: Set this and return false to override the internal checks
|
|
|
|
|
|
2007-07-17 16:44:40 +00:00
|
|
|
'isValidPassword': Override the result of User::isValidPassword()
|
2007-10-21 17:15:37 +00:00
|
|
|
$password: The password entered by the user
|
2007-07-17 16:44:40 +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
|
|
|
|
2007-07-18 08:49:24 +00:00
|
|
|
'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
|
|
|
|
|
&$linksUpdate: the LinkUpdate object
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
|
|
|
|
|
|
|
|
|
|
'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
|
|
|
|
|
|
2007-05-08 18:31:32 +00:00
|
|
|
'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
|
|
|
|
|
No return data is accepted; this hook is for auditing only.
|
2007-05-07 21:54:06 +00:00
|
|
|
$user: the User object being authenticated against
|
|
|
|
|
$password: the password being submitted and found wanting
|
2007-05-08 18:31:32 +00:00
|
|
|
$retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
|
2007-05-07 21:54:06 +00:00
|
|
|
|
2007-11-01 07:02:02 +00:00
|
|
|
'LogLine': Processes a single log entry on Special:Log
|
|
|
|
|
$log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
|
|
|
|
|
database field.
|
|
|
|
|
$log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
|
|
|
|
|
to logging.log_action database field.
|
|
|
|
|
$title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
|
|
|
|
|
$paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
|
|
|
|
|
appears to contain anything.
|
|
|
|
|
&$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
|
|
|
|
|
&$revert: string that is displayed in the UI, similar to $comment.
|
|
|
|
|
|
2006-05-25 07:37:20 +00:00
|
|
|
'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
|
|
|
|
|
&$type: array of strings
|
2005-07-29 15:08:57 +00:00
|
|
|
|
2006-05-25 07:37:20 +00:00
|
|
|
'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
|
|
|
|
|
&$typeText: array of strings
|
2005-07-29 15:08:57 +00:00
|
|
|
|
2006-05-25 07:37:20 +00:00
|
|
|
'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
|
|
|
|
|
&$headerText: array of strings
|
|
|
|
|
|
|
|
|
|
'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
|
|
|
|
|
&$actionText: array of strings
|
2005-07-29 15:08:57 +00:00
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
|
|
|
|
|
$magicWords: array of strings
|
|
|
|
|
|
|
|
|
|
'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
|
|
|
|
|
$variableIDs: array of strings
|
|
|
|
|
|
2006-01-03 15:45:36 +00:00
|
|
|
'MarkPatrolled': before an edit is marked patrolled
|
|
|
|
|
$rcid: ID of the revision to be marked patrolled
|
|
|
|
|
$user: the user (object) marking the revision as patrolled
|
|
|
|
|
$wcOnlySysopsCanPatrol: config setting indicating whether the user
|
|
|
|
|
needs to be a sysop in order to mark an edit patrolled
|
|
|
|
|
|
|
|
|
|
'MarkPatrolledComplete': after an edit is marked patrolled
|
|
|
|
|
$rcid: ID of the revision marked as patrolled
|
|
|
|
|
$user: user (object) who marked the edit patrolled
|
|
|
|
|
$wcOnlySysopsCanPatrol: config setting indicating whether the user
|
|
|
|
|
must be a sysop to patrol the edit
|
|
|
|
|
|
2006-06-26 15:50:03 +00:00
|
|
|
'MathAfterTexvc': after texvc is executed when rendering mathematics
|
|
|
|
|
$mathRenderer: instance of MathRenderer
|
|
|
|
|
$errmsg: error message, in HTML (string). Nonempty indicates failure
|
|
|
|
|
of rendering the formula
|
|
|
|
|
|
2007-11-06 01:16:25 +00:00
|
|
|
'MediaWikiPerformAction': Override MediaWiki::performAction().
|
2007-12-03 19:47:11 +00:00
|
|
|
Use this to do something completely different, after the basic
|
|
|
|
|
globals have been set up, but before ordinary actions take place.
|
2007-11-06 01:16:25 +00:00
|
|
|
$output: $wgOut
|
|
|
|
|
$article: $wgArticle
|
|
|
|
|
$title: $wgTitle
|
|
|
|
|
$user: $wgUser
|
|
|
|
|
$request: $wgRequest
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'MessagesPreLoad': When loading a message from the database
|
|
|
|
|
$title: title of the message (string)
|
|
|
|
|
$message: value (string), change it to the message you want to define
|
|
|
|
|
|
2006-01-13 17:00:05 +00:00
|
|
|
'OutputPageBeforeHTML': a page has been processed by the parser and
|
|
|
|
|
the resulting HTML is about to be displayed.
|
|
|
|
|
$parserOutput: the parserOutput (object) that corresponds to the page
|
|
|
|
|
$text: the text that will be displayed, in HTML (string)
|
|
|
|
|
|
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
|
|
|
|
|
|
2007-03-25 23:42:09 +00:00
|
|
|
'PageHistoryBeforeList': When a history page list is about to be constructed.
|
2007-03-25 23:20:48 +00:00
|
|
|
$article: the article that the history is loading for
|
|
|
|
|
|
2007-03-25 23:42:09 +00:00
|
|
|
'PageHistoryLineEnding' : right before the end <li> is added to a history line
|
2007-03-25 23:20:48 +00:00
|
|
|
$row: the revision row for this line
|
|
|
|
|
$s: the string representing this parsed line
|
|
|
|
|
|
2005-12-25 11:04:40 +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.
|
|
|
|
|
$hash: reference to a hash key string which can be modified
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'ParserAfterStrip': Same as ParserBeforeStrip
|
|
|
|
|
|
|
|
|
|
'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
|
|
|
|
|
$parser: Parser object being used
|
|
|
|
|
$text: text that'll be returned
|
|
|
|
|
|
|
|
|
|
'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
|
|
|
|
|
$parser: Parser object
|
|
|
|
|
$text: text to parse
|
|
|
|
|
$stripState: StripState instance being used
|
|
|
|
|
|
|
|
|
|
'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
|
|
|
|
|
$parser: parser object
|
|
|
|
|
$text: text being parsed
|
|
|
|
|
$stripState: stripState used (object)
|
|
|
|
|
|
|
|
|
|
'ParserBeforeTidy': called before tidy and custom tags replacements
|
|
|
|
|
$parser: Parser object being used
|
|
|
|
|
$text: actual text
|
|
|
|
|
|
|
|
|
|
'ParserClearState': called at the end of Parser::clearState()
|
|
|
|
|
$parser: Parser object being cleared
|
|
|
|
|
|
|
|
|
|
'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
|
|
|
|
|
$parser: Parser object
|
|
|
|
|
$varCache: array to store the value in case of multiples calls of the same magic word
|
|
|
|
|
$index: index (string) of the magic
|
|
|
|
|
$ret: value of the magic word (the hook should set it)
|
|
|
|
|
|
|
|
|
|
'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
|
|
|
|
|
$parser: Parser object
|
|
|
|
|
$time: actual time (timestamp)
|
|
|
|
|
|
|
|
|
|
'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
|
|
|
|
|
$parser: Parser object
|
|
|
|
|
$varCache: varaiable cache (array)
|
|
|
|
|
|
|
|
|
|
'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
|
|
|
|
|
$parser: Parser object
|
|
|
|
|
$limitReport: text that will be included (without comment tags)
|
|
|
|
|
|
|
|
|
|
'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
|
|
|
|
|
$parser: Parser object created
|
|
|
|
|
|
2007-02-09 05:37:44 +00:00
|
|
|
'ParserTestTables': alter the list of tables to duplicate when parser tests
|
|
|
|
|
are run. Use when page save hooks require the presence of custom tables
|
|
|
|
|
to ensure that tests continue to run properly.
|
|
|
|
|
&$tables: array of table names
|
|
|
|
|
|
2006-05-08 22:20:55 +00:00
|
|
|
'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
|
|
|
|
|
my talk page, my contributions" etc).
|
|
|
|
|
|
|
|
|
|
&$personal_urls: Array of link specifiers (see SkinTemplate.php)
|
2006-05-17 07:02:06 +00:00
|
|
|
&$title: Title object representing the current page
|
2006-05-08 22:20:55 +00:00
|
|
|
|
2006-12-22 20:21:14 +00:00
|
|
|
'PingLimiter': Allows extensions to override the results of User::pingLimiter()
|
|
|
|
|
&$user : User performing the action
|
|
|
|
|
$action : Action being performed
|
|
|
|
|
&$result : Whether or not the action should be prevented
|
|
|
|
|
Change $result and return false to give a definitive answer, otherwise
|
|
|
|
|
the built-in rate limiting checks are used, if enabled.
|
|
|
|
|
|
2006-12-30 11:43:42 +00:00
|
|
|
'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
|
|
|
|
|
$form : PreferencesForm object
|
|
|
|
|
&$html : HTML to append to
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'PrefsEmailAudit': called when user changes his email address
|
|
|
|
|
$user: User (object) changing his email address
|
|
|
|
|
$oldaddr: old email address (string)
|
|
|
|
|
$newaddr: new email address (string)
|
|
|
|
|
|
|
|
|
|
'PrefsPasswordAudit': called when user changes his password
|
|
|
|
|
$user: User (object) changing his passoword
|
|
|
|
|
$newPass: new password
|
|
|
|
|
$error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
|
|
|
|
|
|
2007-01-11 14:50:34 +00:00
|
|
|
'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
|
|
|
|
|
&$obj: RawPage object
|
|
|
|
|
&$text: The text that's going to be the output
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'RecentChange_save': called at the end of RecenChange::save()
|
|
|
|
|
$recentChange: RecentChange object
|
|
|
|
|
|
2007-07-30 22:52:37 +00:00
|
|
|
'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
|
|
|
|
|
$form: the PreferencesForm
|
|
|
|
|
$out: output page to render to, probably $wgOut
|
|
|
|
|
|
|
|
|
|
'ResetPreferences': called at the end of PreferencesForm::resetPrefs
|
|
|
|
|
$form: the PreferencesForm
|
|
|
|
|
$user: the User object to load preferences from
|
|
|
|
|
|
|
|
|
|
'SavePreferences': called at the end of PreferencesForm::savePreferences;
|
|
|
|
|
returning false prevents the preferences from being saved.
|
|
|
|
|
$form: the PreferencesForm
|
|
|
|
|
$user: the User object to save preferences to
|
|
|
|
|
$message: change this to set an error message (ignored if the hook does notreturn fals)
|
|
|
|
|
|
2007-04-10 02:18:42 +00:00
|
|
|
'SearchUpdate': Prior to search update completion
|
|
|
|
|
$id : Page id
|
|
|
|
|
$namespace : Page namespace
|
|
|
|
|
$title : Page title
|
|
|
|
|
$text : Current text being indexed
|
|
|
|
|
|
2007-08-28 21:53:50 +00:00
|
|
|
'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
|
|
|
|
|
$text: Text being shown
|
|
|
|
|
$title: Title of the custom script/stylesheet page
|
|
|
|
|
$output: Current OutputPage object
|
|
|
|
|
|
2006-06-04 16:55:19 +00:00
|
|
|
'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
|
|
|
|
|
&$siteNotice: HTML returned as the sitenotice
|
|
|
|
|
Return true to allow the normal method of notice selection/rendering to work,
|
|
|
|
|
or change the value of $siteNotice and return false to alter it.
|
|
|
|
|
|
|
|
|
|
'SiteNoticeAfter': After the sitenotice/anonnotice is composed
|
|
|
|
|
&$siteNotice: HTML sitenotice
|
|
|
|
|
Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
|
|
|
|
|
|
2007-08-23 22:34:12 +00:00
|
|
|
'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
|
|
|
|
|
$skin: Skin object
|
|
|
|
|
&$text: bottomScripts Text
|
|
|
|
|
Append to $text to add additional text/scripts after the stock bottom scripts.
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
|
|
|
|
|
$sktemplate: SkinTemplate object
|
|
|
|
|
$content_actions: array of tabs
|
|
|
|
|
|
|
|
|
|
'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
|
|
|
|
|
$sktemplate: SkinTemplate object
|
|
|
|
|
$nav_urls: array of tabs
|
|
|
|
|
|
2007-08-28 21:53:50 +00:00
|
|
|
'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
|
|
|
|
|
&$content_actions: Content actions
|
|
|
|
|
[See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
|
|
|
|
|
for an example]
|
|
|
|
|
|
2007-01-10 15:23:32 +00:00
|
|
|
'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
|
|
|
|
|
&$sktemplate: SkinTemplate object
|
|
|
|
|
&$tpl: Template engine object
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
|
|
|
|
|
$sktemplate: SkinTemplate object
|
|
|
|
|
$res: set to true to prevent active tabs
|
|
|
|
|
|
|
|
|
|
'SkinTemplateSetupPageCss': use this to provide per-page CSS
|
|
|
|
|
$out: Css to return
|
|
|
|
|
|
2007-11-06 01:16:25 +00:00
|
|
|
'SkinTemplateTabAction': Override SkinTemplate::tabAction().
|
|
|
|
|
You can either create your own array, or alter the parameters for the normal one.
|
|
|
|
|
&$this: The SkinTemplate instance.
|
|
|
|
|
$title: Title instance for the page.
|
|
|
|
|
$message: Visible label of tab.
|
|
|
|
|
$selected: Whether this is a selected tab.
|
|
|
|
|
$checkEdit: Whether or not the action=edit query should be added if appropriate.
|
|
|
|
|
&$classes: Array of CSS classes to apply.
|
|
|
|
|
&$query: Query string to add to link.
|
|
|
|
|
&$text: Link text.
|
|
|
|
|
&$result: Complete assoc. array if you want to return true.
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'SkinTemplateTabs': called when finished to build the actions tabs
|
|
|
|
|
$sktemplate: SkinTemplate object
|
|
|
|
|
$content_actions: array of tabs
|
|
|
|
|
|
2007-07-16 11:30:27 +00:00
|
|
|
'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
|
|
|
|
|
$id: User identifier
|
2007-07-16 07:11:25 +00:00
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'SpecialMovepageAfterMove': called after moving a page
|
|
|
|
|
$movePage: MovePageForm object
|
|
|
|
|
$oldTitle: old title (object)
|
|
|
|
|
$newTitle: new title (object)
|
|
|
|
|
|
|
|
|
|
'SpecialPageExecuteAfterPage': called after executing a special page
|
|
|
|
|
Warning: Not all the special pages call this hook
|
|
|
|
|
$specialPage: SpecialPage object
|
|
|
|
|
$par: paramter passed to the special page (string)
|
|
|
|
|
$funct: function called to execute the special page
|
|
|
|
|
|
|
|
|
|
'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
|
|
|
|
|
Warning: Not all the special pages call this hook
|
|
|
|
|
$specialPage: SpecialPage object
|
|
|
|
|
$par: paramter passed to the special page (string)
|
|
|
|
|
$funct: function called to execute the special page
|
|
|
|
|
|
|
|
|
|
'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
|
|
|
|
|
Warning: Not all the special pages call this hook
|
|
|
|
|
$specialPage: SpecialPage object
|
|
|
|
|
$par: paramter passed to the special page (string)
|
|
|
|
|
$funct: function called to execute the special page
|
|
|
|
|
|
|
|
|
|
'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
|
|
|
|
|
$list: list (array) of core special pages
|
|
|
|
|
|
|
|
|
|
'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
|
|
|
|
|
$title: title object generated from the text entred by the user
|
|
|
|
|
|
|
|
|
|
'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
|
|
|
|
|
$extTypes: associative array of extensions types
|
|
|
|
|
|
Changed the calling protocol for function wfRunHooks() in Hooks.php.
Previously, this function used variable arguments to allow
different hooks to pass different parameters. However, var args
silently convert reference-calling to value-calling. So a call
that used to work like this:
# old
wfRunHooks('SomeEvent', $param1, &$param2, $param3);
...now works like this:
# new
wfRunHooks('SomeEvent', array($param1, &$param2, $param3));
Hook functions can now change pass-by-reference parameters correctly
(e.g. $param2 in the above example).
All calls to wfRunHooks() were changed and tested, and the change
was documented in docs/hooks.doc. This change was originally checked
in on REL1_4 branch as a bugfix, but per vibber reverted and checked
in to HEAD instead.
2005-03-13 15:29:43 +00:00
|
|
|
'TitleMoveComplete': after moving an article (title)
|
|
|
|
|
$old: old title
|
|
|
|
|
$nt: new title
|
|
|
|
|
$user: user who did the move
|
2005-06-01 02:31:45 +00:00
|
|
|
$pageid: database ID of the page that's been moved
|
|
|
|
|
$redirid: database ID of the created redirect
|
Changed the calling protocol for function wfRunHooks() in Hooks.php.
Previously, this function used variable arguments to allow
different hooks to pass different parameters. However, var args
silently convert reference-calling to value-calling. So a call
that used to work like this:
# old
wfRunHooks('SomeEvent', $param1, &$param2, $param3);
...now works like this:
# new
wfRunHooks('SomeEvent', array($param1, &$param2, $param3));
Hook functions can now change pass-by-reference parameters correctly
(e.g. $param2 in the above example).
All calls to wfRunHooks() were changed and tested, and the change
was documented in docs/hooks.doc. This change was originally checked
in on REL1_4 branch as a bugfix, but per vibber reverted and checked
in to HEAD instead.
2005-03-13 15:29:43 +00:00
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'UndeleteShowRevision': called when showing a revision in Special:Undelete
|
|
|
|
|
$title: title object related to the revision
|
|
|
|
|
$rev: revision (object) that will be viewed
|
|
|
|
|
|
2004-11-28 07:06:25 +00:00
|
|
|
'UnknownAction': An unknown "action" has occured (useful for defining
|
|
|
|
|
your own actions)
|
|
|
|
|
$action: action name
|
|
|
|
|
$article: article "acted on"
|
|
|
|
|
|
2004-11-30 05:45:56 +00:00
|
|
|
'UnwatchArticle': before a watch is removed from an article
|
|
|
|
|
$user: user watching
|
|
|
|
|
$article: article object to be removed
|
|
|
|
|
|
|
|
|
|
'UnwatchArticle': after a watch is removed from an article
|
|
|
|
|
$user: user that was watching
|
|
|
|
|
$article: article object removed
|
|
|
|
|
|
2007-08-28 21:53:50 +00:00
|
|
|
'UnwatchArticleComplete': after a watch is removed from an article
|
|
|
|
|
$user: user that watched
|
|
|
|
|
$article: article object that was watched
|
|
|
|
|
|
2006-11-25 13:51:50 +00:00
|
|
|
'UploadForm:initial': before the upload form is generated
|
|
|
|
|
$form: UploadForm object
|
|
|
|
|
You might set the member-variables $uploadFormTextTop and
|
|
|
|
|
$uploadFormTextAfterSummary to inject text (HTML) either before
|
|
|
|
|
or after the editform.
|
|
|
|
|
|
2006-11-29 18:21:56 +00:00
|
|
|
'UploadForm:BeforeProcessing': at the beginning of processUpload()
|
|
|
|
|
$form: UploadForm object
|
|
|
|
|
Lets you poke at member variables like $mUploadDescription before the
|
|
|
|
|
file is saved.
|
|
|
|
|
|
2005-09-06 04:53:59 +00:00
|
|
|
'UploadVerification': additional chances to reject an uploaded file
|
|
|
|
|
string $saveName: destination file name
|
|
|
|
|
string $tempName: filesystem path to the temporary file for checks
|
|
|
|
|
string &$error: output: HTML error to show if upload canceled by returning false
|
|
|
|
|
|
2006-04-13 18:29:18 +00:00
|
|
|
'UploadComplete': Upon completion of a file upload
|
|
|
|
|
$image: Image object representing the file that was uploaded
|
|
|
|
|
|
2007-11-30 17:28:24 +00:00
|
|
|
'userCan': To interrupt/advise the "user can do X to Y article" check.
|
2007-10-10 09:56:47 +00:00
|
|
|
If you want to display an error message, try getUserPermissionsErrors.
|
2006-02-05 18:53:37 +00:00
|
|
|
$title: Title object being checked against
|
|
|
|
|
$user : Current user object
|
|
|
|
|
$action: Action being checked
|
2006-04-04 08:46:06 +00:00
|
|
|
$result: Pointer to result returned if hook returns false. If null is returned,
|
2007-11-30 17:28:24 +00:00
|
|
|
userCan checks are continued by internal code.
|
2006-02-05 18:53:37 +00:00
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
|
|
|
|
|
$user: User (object) that'll clear the message
|
|
|
|
|
|
2006-01-29 07:35:28 +00:00
|
|
|
'UserCreateForm': change to manipulate the login form
|
|
|
|
|
$template: SimpleTemplate instance for the form
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'UserEffectiveGroups': Called in User::getEffectiveGroups()
|
|
|
|
|
$user: User to get groups for
|
|
|
|
|
&$groups: Current effective groups
|
|
|
|
|
|
2004-11-27 23:10:05 +00:00
|
|
|
'UserLoginComplete': after a user has logged in
|
|
|
|
|
$user: the user object that was created on login
|
|
|
|
|
|
2006-01-29 07:35:28 +00:00
|
|
|
'UserLoginForm': change to manipulate the login form
|
|
|
|
|
$template: SimpleTemplate instance for the form
|
|
|
|
|
|
2004-11-27 23:10:05 +00:00
|
|
|
'UserLogout': before a user logs out
|
|
|
|
|
$user: the user object that is about to be logged out
|
|
|
|
|
|
|
|
|
|
'UserLogoutComplete': after a user has logged out
|
|
|
|
|
$user: the user object _after_ logout (won't have name, ID, etc.)
|
2006-03-29 02:31:15 +00:00
|
|
|
|
|
|
|
|
'UserRights': After a user's group memberships are changed
|
|
|
|
|
$user : User object that was changed
|
|
|
|
|
$add : Array of strings corresponding to groups added
|
|
|
|
|
$remove: Array of strings corresponding to groups removed
|
2004-11-27 23:10:05 +00:00
|
|
|
|
2007-08-09 16:36:15 +00:00
|
|
|
'UserGetImplicitGroups': Called in User::getImplicitGroups()
|
|
|
|
|
&$groups: List of implicit (automatically-assigned) groups
|
|
|
|
|
|
2007-07-21 01:00:42 +00:00
|
|
|
'UserGetRights': Called in User::getRights()
|
|
|
|
|
$user: User to get rights for
|
|
|
|
|
&$rights: Current rights
|
|
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
|
|
|
|
|
$user: user retrieving new talks messages
|
|
|
|
|
$talks: array of new talks page(s)
|
|
|
|
|
|
|
|
|
|
'UserToggles': called when initialising User::$mToggles, use this to add new toggles
|
|
|
|
|
$toggles: array of toggles to add
|
2007-06-27 14:32:31 +00:00
|
|
|
|
2007-08-28 21:53:50 +00:00
|
|
|
'WatchArticle': before a watch is added to an article
|
|
|
|
|
$user: user that will watch
|
|
|
|
|
$article: article object to be watched
|
2005-07-29 15:08:57 +00:00
|
|
|
|
2007-08-28 21:53:50 +00:00
|
|
|
'WatchArticleComplete': after a watch is added to an article
|
|
|
|
|
$user: user that watched
|
|
|
|
|
$article: article object watched
|
2007-07-02 23:22:39 +00:00
|
|
|
|
2007-12-03 19:47:11 +00:00
|
|
|
'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
|
|
|
|
|
$query: $wgQueryPages itself
|
2007-01-21 16:46:36 +00:00
|
|
|
|
2006-05-02 20:59:56 +00:00
|
|
|
More hooks might be available but undocumented, you can execute
|
2007-10-21 17:15:37 +00:00
|
|
|
./maintenance/findhooks.php to find hidden one.
|
