Merge "Document SkinVectorStyleModules hook"
authorJdlrobson <jrobson@wikimedia.org>
Fri, 7 Feb 2014 20:11:38 +0000 (20:11 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Fri, 7 Feb 2014 20:11:38 +0000 (20:11 +0000)
1  2 
docs/hooks.txt

diff --combined docs/hooks.txt
@@@ -269,9 -269,6 +269,9 @@@ $reason: the reason for the move (adde
  'AbortNewAccount': Return false to cancel explicit account creation.
  $user: the User object about to be created (read-only, incomplete)
  &$msg: out parameter: HTML to display on abort
 +&$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.
  
  'AbortTalkPageEmailNotification': Return false to cancel talk page email notification
  $targetUser: the user whom to send talk page email notification
@@@ -298,15 -295,6 +298,15 @@@ $article: Article objec
  $user: the User object that was created. (Parameter added in 1.7)
  $byEmail: true when account was created "by email" (added in 1.12)
  
 +'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
 +
  'AfterFinalPageOutput': At the end of OutputPage::output() but before 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
@@@ -541,7 -529,6 +541,7 @@@ $wikiPage: WikiPage (object) being modi
  Wiki::articleFromTitle().
  $title: Title (object) used to create the article object
  $article: Article (object) that will be returned
 +$context: IContextSource (object)
  
  'ArticleInsertComplete': After a new article is created. DEPRECATED, use
  PageContentInsertComplete.
@@@ -776,7 -763,6 +776,7 @@@ $block: Block object (which is set to b
  '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)
 +&$reason: if the hook is aborted, the error message to be returned in an array
  
  'BlockIpComplete': After an IP address or user is blocked.
  $block: the Block object that was saved
@@@ -847,15 -833,6 +847,15 @@@ content model name, but no entry for th
  $modeName: the requested content model name
  &$handler: set this to a ContentHandler object, if desired.
  
 +'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.
 +
  'ConvertContent': Called by AbstractContent::convert when a conversion to another
  content model is requested.
  $content: The Content object to be converted.
@@@ -908,9 -885,8 +908,9 @@@ $new: the ?new= param value from the ur
  
  'DiffRevisionTools': Override or extend the revision tools available from the
  diff view, i.e. undo, etc.
 -$rev: Revision object
 +$newRev: Revision object of the "new" revision
  &$links: Array of HTML links
 +$oldRev: Revision object of the "old" revision (may be null)
  
  'DiffViewHeader': Called before diff display
  $diff: DifferenceEngine object that's calling
@@@ -1570,7 -1546,6 +1570,7 @@@ cache
  $cache: The LocalisationCache object
  $code: language code
  &$alldata: The localisation data from core and extensions
 +&purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
  
  'LocalisationChecksBlacklist': When fetching the blacklist of
  localisation checks.
@@@ -1620,12 -1595,6 +1620,12 @@@ $paramArray: Array of parameters that c
  &$revert: string that is displayed in the UI, similar to $comment.
  $time: timestamp of the log entry (added in 1.12)
  
 +'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
 +
  'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
  script.
  $refreshLinks: RefreshLinks object
@@@ -1823,8 -1792,7 +1823,8 @@@ $queryInfo: the query parameter
  '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
 +&$confstr: reference to a hash key string which can be modified
 +$user: User (object) requesting the page
  
  'ParserAfterParse': Called from Parser::parse() just after the call to
  Parser::internalParse() returns.
@@@ -1967,12 -1935,6 +1967,12 @@@ $form: the PreferencesForm object. Thi
  $key: the section name
  &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
  
 +'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
 +
  'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
  AJAX search suggestions. Put results into &$results outparam and return false.
  $ns : array of int namespace keys to search in
@@@ -2193,13 -2155,6 +2193,13 @@@ link" tab
  $sktemplate: SkinTemplate object
  $nav_urls: array of tabs
  
 +'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
 +
  To alter the structured navigation links in SkinTemplates, there are three
  hooks called in different spots:
  
@@@ -2243,19 -2198,18 +2243,24 @@@ $dummy: Called when SkinTemplateToolbox
    dummy parameter with "$dummy=false" in their code and return without echoing
    any HTML to avoid creating duplicate toolbox items.
  
+ '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
  'SoftwareInfo': Called by Special:Version for returning information about the
  software.
  $software: The array of software in format 'name' => 'version'. See
    SpecialVersion::softwareInformation().
  
 +'SpecialBlockModifyFormFields': Add more fields to Special:Block
 +$sp: SpecialPage object, for context
 +&$fields: Current HTMLForm fields
 +
  'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
 -$id: User identifier
 +$id: User id number, only provided for backwards-compatability
 +$user: User object representing user contributions are being fetched for
 +$sp: SpecialPage instance, providing context
  
  'SpecialListusersDefaultQuery': Called right before the end of
  UsersPager::getDefaultQuery().
@@@ -2444,7 -2398,7 +2449,7 @@@ $special: the special page objec
  &$tables: array of tables to be queried
  &$join_conds: join conditions for the tables
  &$fields: array of query fields
 -$values: array of variables with watchlist options
 +$opts: A FormOptions object with watchlist options for the current request
  
  'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
  SpecialWatchlist. Allows extensions to register custom values they have