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:
$user: the User object about to be created (read-only, incomplete)
$message: out parameter: error message to display on abort
+'AbortNewAccountAuto': Return false to cancel account creation when the
+ request is coming from an AuthPlugin or ExtUser, rather than a
+ manually-submitted CreateAccount form.
+$user: the User object about to be created (read-only, incomplete)
+$message: out parameter: error message to display on abort
+
'AddNewAccount': after a user account is created
$user: the User object that was created. (Parameter added in 1.7)
$byEmail: true when account was created "by email" (added in 1.12)
'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
+$EditPage: the EditPage object
'APIAfterExecute': after calling the execute() method of an API module.
Use this to extend core API modules.
if $resultArr was filled.
$EditPage : the EditPage object
$text : the new text of the article (has yet to be saved)
-$resultArr : data in this array will be added to the API result
+&$resultArr : data in this array will be added to the API result
'APIGetAllowedParams': use this hook to modify a module's parameters.
&$module: Module object
$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)
+$comment: The comment associated with the undeletion.
'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
before the user is redirected back to the page
&$nt: the image title
&$time: image timestamp
+'BeforeInitialize': before anything is initialized in performRequestForTitle()
+&$title: Title being used for request
+&$article: The associated Article object
+&$output: OutputPage object
+&$user: User
+$request: WebRequest object
+$this: Mediawiki object
+
'BeforePageDisplay': Prior to outputting a page
&$out: OutputPage object
&$skin: Skin object
$unpatrolled: Whether or not we are showing unpatrolled changes.
$watched: Whether or not the change is watched by the user.
+'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
+$user: user (object) whose email is being confirmed
+
'ContribsPager::getQueryInfo': Before the contributions query is about to run
&$pager: Pager object for contributions
&queryInfo: The query for the contribs Pager
if implementing a custom editor, e.g. for a special namespace,
etc.
+'DatabaseOraclePostInit': Called after initialising an Oracle database
+&$db: the DatabaseOracle object
+
'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
'EditFilterMerged': Post-section-merge edit filter
$editor: EditPage instance (object)
$text: content of the edit box
-$error: error message to return
+&$error: error message to return
$summary: Edit summary for page
'EditFormPreloadText': Allows population of the edit form when creating
'EditPage::attemptSave': called before an article is
saved, that is before insertNewArticle() is called
-&$editpage_Obj: the current EditPage object
+$editpage_Obj: the current EditPage object
+
+'EditPage::importFormData': allow extensions to read additional data
+posted in the form
+$editpage: EditPage instance
+$request: Webrequest
+return value is ignored (should always return true)
'EditPage::showEditForm:fields': allows injection of form field into edit form
&$editor: the EditPage instance for reference
&$checks: Array of edit checks like "watch this page"/"minor edit"
&$tabindex: HTML tabindex of the last edit check/button
+'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
+textarea in the edit form
+&$toolbar: The toolbar HTMl
+
+'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
+$title: title of page being edited
+&$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
+
+'EditPageTosSummary': Give a chance for site and per-namespace customizations
+of terms of service summary link that might exist separately from the copyright
+notice.
+$title: title of page being edited
+&$msg: localization message name, overridable. Default is 'editpage-tos-summary'
+
'EditSectionLink': Do not use, use DoEditSectionLink instead.
$skin: Skin rendering the UI
$title: Title being linked to
&$text: string containing partially parsed text
&$this->mStripState: Parser's internal StripState object
+'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
+$user: user (object) whose email is being invalidated
+
'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
$article: article (object) being checked
'isValidPassword': Override the result of User::isValidPassword()
$password: The password entered by the user
-&$result: Set this and return false to override the internal checks
+&$result: Set this to either true (passes) or the key for a message error
$user: User the password is being validated for
-'LanguageGetMagic': Use this to define synonyms of magic words depending
-of the language
+'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
+$wgExtensionMessagesFiles instead.
+Use this to define synonyms of magic words depending of the language
$magicExtensions: associative array of magic words synonyms
$lang: laguage code (string)
-'LanguageGetSpecialPageAliases': Use to define aliases of special pages
-names depending of the language
+'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
+listed in $wgExtensionMessagesFiles instead.
+Use to define aliases of special pages names depending of the language
$specialPageAliases: associative array of magic words synonyms
$lang: laguage code (string)
'ListDefinedTags': When trying to find all defined tags.
&$tags: The list of tags.
-'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions
-messages
-&$messageCache: The MessageCache object
-
'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading
database schema
$opts: query options
$join_conds: JOIN conditions
+'LocalisationCacheRecache': Called when loading the localisation data into cache
+$cache: The LocalisationCache object
+$code: language code
+&$alldata: The localisation data from core and extensions
+
'LoginAuthenticateAudit': a login attempt for a valid user account either
succeeded or failed. No return data is accepted; this hook is for auditing only.
$user: the User object being authenticated against
&$actionText: array of strings
'MagicWordMagicWords': When defining new magic word.
-DEPRECATED: Use LanguageGetMagic hook instead
+DEPRECATED: use $magicWords in a file listed in
+$wgExtensionMessagesFiles instead.
$magicWords: array of strings
'MagicWordwgVariableIDs': When definig new magic words IDs.
$title: name of the page changed.
$text: new contents of the page.
-'MessageNotInMwNs': When trying to get a message that isn't found in the
-MediaWiki namespace (but before checking the message files)
-&$message: message's content; can be changed
-$lckey: message's name
-$langcode: language code
-$isFullKey: specifies whether $lckey is a two part key "msg/lang"
+'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.
'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
been rendered (useful for adding more)
same magic word
$index: index (string) of the magic
$ret: value of the magic word (the hook should set it)
+$frame: PPFrame object to use for expanding any template variables
'ParserGetVariableValueTs': use this to change the value of the time for the
{{LOCAL...}} magic word
$newPass: new password
$error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
+'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
+$article: the title being (un)protected
+$output: a string of the form HTML so far
+
+'ProtectionForm::save': called when a protection form is submitted
+$article: the title being (un)protected
+$errorMsg: an html message string of an error
+
+'ProtectionForm::showLogExtract': called after the protection log extract is shown
+$article: the page the form is shown for
+$out: OutputPage object
+
'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
&$obj: RawPage object
&$text: The text that's going to be the output
'SetupAfterCache': Called in Setup.php, after cache objects are set
+'ShowMissingArticle': Called when generating the output for a non-existent page
+$article: The article object corresponding to the page
+
'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
+'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.
+
'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,
&$bar: Sidebar contents
Modify $bar to add or modify sidebar portlets.
+'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
+$title: displayed page title
+$type: 'normal' or 'history' for old/diff views
+&$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
+&$link: overridable HTML link to be passed into the message as $1
+
'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
$skin: Skin object
&$subpages: Subpage links HTML
[See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
for an example]
+'SkinTemplateNavigation': Alter the structured navigation links in SkinTemplates
+&$sktemplate: SkinTemplate object
+&$links: Structured navigation links
+This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
+
'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
starts page output
&$sktemplate: SkinTemplate object
hook to remove a core special page
$list: list (array) of core special pages
+'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
+use this to change some selection criteria or substitute a different title
+&$randstr: The random number from wfRandom()
+&$isRedir: Boolean, whether to select a redirect or non-redirect
+&$namespaces: An array of namespace indexes to get the title from
+&$extra: An array of extra SQL statements
+&$title: If the hook returns false, a Title object to use instead of the
+result from the normal query
+
'SpecialRecentChangesPanel': called when building form options in
SpecialRecentChanges
&$extraOpts: array of added items, to which can be added
target doesn't exist
$title: title object generated from the text entred by the user
+'SpecialSearchProfiles': allows modification of search profiles
+&$profiles: profiles, which can be modified.
+
'SpecialSearchResults': called before search result display when there
are matches
$term: string of search term
no matches
$term: string of search term
+'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
+&$extraStats: Array to save the new stats
+ ( $extraStats['<name of statistic>'] => <value>; )
+
+'SpecialUploadComplete': Called after successfully uploading a file from
+Special:Upload
+$form: The UploadForm object
+
'SpecialVersionExtensionTypes': called when generating the extensions credits,
use this to change the tables headers
$extTypes: associative array of extensions types
string &$error: output: HTML error to show if upload canceled by returning false
'UploadComplete': Upon completion of a file upload
-$uploadForm: Upload form object. File can be accessed by
- $uploadForm->mLocalFile.
+$uploadBase: UploadBase (or subclass) object. File can be accessed by
+ $uploadBase->getLocalFile().
'User::mailPasswordInternal': before creation and mailing of a user's new
temporary password
$user: User (object) whose permission is being checked
&$canSend: bool set on input, can override on output
-
'UserClearNewTalkNotification': called when clearing the
"You have new messages!" message, return false to not delete it
$user: User (object) that'll clear the message
&$groups: List of implicit (automatically-assigned) groups
'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
-*&$reservedUsernames: $wgReservedUsernames
+&$reservedUsernames: $wgReservedUsernames
'UserGetRights': Called in User::getRights()
$user: User to get rights for
'UserLoginMailPassword': Block users from emailing passwords
$name: the username to email the password of.
-&$error: out-param ÐÊthe error message to return.
+&$error: out-param - the error message to return.
'UserLogout': before a user logs out
$user: the user object that is about to be logged out
$add : Array of strings corresponding to groups added
$remove: Array of strings corresponding to groups removed
-'UserrightsChangeableGroups': allows modification of the groups a user
-may add or remove via Special:UserRights
-$userrights : UserrightsPage object
-$user : User object of the current user
-$addergroups : Array of groups that the user is in
-&$groups : Array of groups that can be added or removed. In format of
- array(
- 'add' => array( addablegroups ),
- 'remove' => array( removablegroups ),
- 'add-self' => array( addablegroups to self ),
- 'remove-self' => array( removable groups from self )
- )
-
-'UserrightsGroupCheckboxes': allows modification of the display of
-checkboxes in the Special:UserRights interface.
-$usergroups : Array of groups that the target user belongs to
-&$columns : Array of checkboxes, in the form of
- $columns['column name']['group name'] = array(
- 'set' => is this checkbox checked by default?
- 'disabled' => is this checkbox disabled?
- 'irreversible' => can this action not be reversed?
- );
-
-'UserrightsSaveUserGroups': allow extensions to modify the added/removed groups
-&$user : User object of the user being altered
-$oldGroups : Array of groups that the user is currently in
-&$add : Array of groups to add
-&$remove : Array of groups to remove
-$reason : Summary provided by user on the form
-
'UserRetrieveNewTalks': called when retrieving "You have new messages!"
message(s)
$user: user retrieving new talks messages
new toggles
$toggles: array of toggles to add
+'VectorTemplateToolboxEnd': Called by Vector skin after toolbox links have
+been rendered (useful for adding more)
+Note: this is only run for the Vector skin. To add items to the toolbox
+for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
+instead.
+$tools: array of tools
+
'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to
alter the SQL query which gets the list of wanted pages
&$wantedPages: WantedPagesPage object
query pages to be updated with maintenance/updateSpecialPages.php
$query: $wgQueryPages itself
+'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
+ metadata to be added.
+$obj: The XmlDumpWriter object.
+&$out: The output string.
+$row: The database row for the page.
+$title: The title of the page.
+
+'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
+ metadata.
+$obj: The XmlDumpWriter object.
+&$out: The text being output.
+$row: The database row for the revision.
+$text: The revision text.
+
More hooks might be available but undocumented, you can execute
./maintenance/findhooks.php to find hidden one.
dépôts / lhc / web / wiklou.git / blobdiff