Semantic MediaWiki and related extensions
Public Member Functions | Static Public Member Functions | List of all members
SMW\MediaWiki\Hooks Class Reference

Public Member Functions

 __construct ( $localDirectory='')
 
 isRegistered ( $name)
 
 clear (string $name='')
 
 getHandlerFor ( $name)
 
 getHandlerList ()
 
 register (&$vars)
 
 onParserAfterTidy (&$parser, &$text)
 
 onBaseTemplateToolbox ( $skinTemplate, &$toolbox)
 
 onSidebarBeforeOutput ( $skin, &$sidebar)
 
 onSkinAfterContent (&$data, $skin=null)
 
 onOutputPageParserOutput (&$outputPage, $parserOutput)
 
 onOutputPageCheckLastModified (&$lastModified)
 
 onBeforePageDisplay (&$outputPage, &$skin)
 
 onSpecialSearchResultsPrepend ( $specialSearch, $outputPage, $term)
 
 onSpecialSearchProfiles (array &$profiles)
 
 onSpecialSearchProfileForm ( $specialSearch, &$form, $profile, $term, $opts)
 
 onInternalParseBeforeLinks (&$parser, &$text, &$stripState)
 
 onNewRevisionFromEditComplete ( $wikiPage, $revision, $baseId, $user)
 
 onArticleProtectComplete (&$wikiPage, &$user, $protections, $reason)
 
 onArticleViewHeader (&$page, &$outputDone, &$useParserCache)
 
 onRejectParserCacheValue ( $value, $page, $popts)
 
 onTitleMoveComplete ( $oldTitle, $newTitle, $user, $oldId, $newId)
 
 onArticlePurge (&$wikiPage)
 
 onArticleDelete (&$wikiPage, &$user, &$reason, &$error)
 
 onLinksUpdateConstructed ( $linksUpdate)
 
 onContentHandlerForModelID ( $modelId, &$contentHandler)
 
 onSpecialStatsAddExtra (&$extraStats, IContextSource $context)
 
 onFileUpload ( $file, $reupload)
 
 onMaintenanceUpdateAddParams (&$params)
 
 onResourceLoaderGetConfigVars (&$vars)
 
 onGetPreferences ( $user, &$preferences)
 
 onPersonalUrls (array &$personal_urls, $title, $skinTemplate)
 
 onSkinTemplateNavigation (&$skinTemplate, &$links)
 
 onLoadExtensionSchemaUpdates ( $databaseUpdater)
 
 onResourceLoaderTestModules (&$testModules, &$resourceLoader)
 
 onExtensionTypes (&$extTypes)
 
 onTitleIsAlwaysKnown ( $title, &$result)
 
 onArticleFromTitle (&$title, &$article)
 
 onTitleIsMovable ( $title, &$isMovable)
 
 onBeforeDisplayNoArticleText ( $article)
 
 onEditPageShowEditFormInitial ( $editPage, $output)
 
 onTitleQuickPermissions ( $title, $user, $action, &$errors, $rigor, $short)
 
 onParserOptionsRegister (&$defaults, &$inCacheKey)
 
 onParserFirstCallInit (&$parser)
 
 onDeleteAccount ( $user)
 
 onBlockIpComplete ( $block, $performer, $priorBlock)
 
 onUnblockUserComplete ( $block, $performer)
 
 onUserGroupsChanged ( $user)
 
 onSoftwareInfo (&$software)
 
 onAfterDataUpdateComplete ( $store, $semanticData, $changeOp)
 
 onBeforeQueryResultLookupComplete ( $store, $query, &$result, $queryEngine)
 
 onAfterQueryResultLookupComplete ( $store, &$result)
 
 onAfterIncomingPropertiesLookupComplete ( $store, $semanticData, $requestOptions)
 
 onBeforeIncomingPropertyValuesFurtherLinkCreate ( $property, $subject, &$html, $store)
 
 onAfterCreateTablesComplete ( $tableBuilder, $messageReporter, $options)
 
 onAdminLinks (\ALTree $admin_links_tree)
 
 onPageSchemasRegisterHandlers ()
 

Static Public Member Functions

static registerExtensionCheck (array &$vars)
 
static registerEarly (array &$vars)
 

Detailed Description

GNU GPL v2+

Since
2.1
Author
mwjames

Constructor & Destructor Documentation

◆ __construct()

SMW\MediaWiki\Hooks::__construct (   $localDirectory = '')
Since
2.1
Parameters
string$localDirectory

Member Function Documentation

◆ clear()

SMW\MediaWiki\Hooks::clear ( string  $name = '')
Since
2.3
Parameters
string$name

◆ getHandlerFor()

SMW\MediaWiki\Hooks::getHandlerFor (   $name)
Since
2.3
Parameters
string$name
Returns
Callable|false

◆ getHandlerList()

SMW\MediaWiki\Hooks::getHandlerList ( )
Since
2.3
Returns
array

◆ isRegistered()

SMW\MediaWiki\Hooks::isRegistered (   $name)
Since
2.3
Parameters
string$name
Returns
boolean

◆ onAfterCreateTablesComplete()

SMW\MediaWiki\Hooks::onAfterCreateTablesComplete (   $tableBuilder,
  $messageReporter,
  $options 
)

◆ onAfterDataUpdateComplete()

SMW\MediaWiki\Hooks::onAfterDataUpdateComplete (   $store,
  $semanticData,
  $changeOp 
)

◆ onAfterIncomingPropertiesLookupComplete()

SMW\MediaWiki\Hooks::onAfterIncomingPropertiesLookupComplete (   $store,
  $semanticData,
  $requestOptions 
)

◆ onAfterQueryResultLookupComplete()

SMW\MediaWiki\Hooks::onAfterQueryResultLookupComplete (   $store,
$result 
)

◆ onArticleDelete()

SMW\MediaWiki\Hooks::onArticleDelete ( $wikiPage,
$user,
$reason,
$error 
)

Hook: ArticleDelete occurs whenever the software receives a request to delete an article

See also
https://www.mediawiki.org/wiki/Manual:Hooks/ArticleDelete

◆ onArticleFromTitle()

SMW\MediaWiki\Hooks::onArticleFromTitle ( $title,
$article 
)

◆ onArticleProtectComplete()

SMW\MediaWiki\Hooks::onArticleProtectComplete ( $wikiPage,
$user,
  $protections,
  $reason 
)

Hook: Occurs after the protect article request has been processed

See also
https://www.mediawiki.org/wiki/Manual:Hooks/ArticleProtectComplete

◆ onArticlePurge()

SMW\MediaWiki\Hooks::onArticlePurge ( $wikiPage)

Hook: ArticlePurge executes before running "&action=purge"

See also
https://www.mediawiki.org/wiki/Manual:Hooks/ArticlePurge

◆ onArticleViewHeader()

SMW\MediaWiki\Hooks::onArticleViewHeader ( $page,
$outputDone,
$useParserCache 
)

Hook: Occurs when an articleheader is shown

See also
https://www.mediawiki.org/wiki/Manual:Hooks/ArticleViewHeader

◆ onBaseTemplateToolbox()

SMW\MediaWiki\Hooks::onBaseTemplateToolbox (   $skinTemplate,
$toolbox 
)

Hook: Called by BaseTemplate when building the toolbox array and returning it for the skin to output.

See also
https://www.mediawiki.org/wiki/Manual:Hooks/BaseTemplateToolbox

◆ onBeforeDisplayNoArticleText()

SMW\MediaWiki\Hooks::onBeforeDisplayNoArticleText (   $article)

◆ onBeforeIncomingPropertyValuesFurtherLinkCreate()

SMW\MediaWiki\Hooks::onBeforeIncomingPropertyValuesFurtherLinkCreate (   $property,
  $subject,
$html,
  $store 
)

◆ onBeforePageDisplay()

SMW\MediaWiki\Hooks::onBeforePageDisplay ( $outputPage,
$skin 
)

Hook: Add changes to the output page, e.g. adding of CSS or JavaScript

See also
https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay

◆ onBeforeQueryResultLookupComplete()

SMW\MediaWiki\Hooks::onBeforeQueryResultLookupComplete (   $store,
  $query,
$result,
  $queryEngine 
)

◆ onBlockIpComplete()

SMW\MediaWiki\Hooks::onBlockIpComplete (   $block,
  $performer,
  $priorBlock 
)
See also
https://www.mediawiki.org/wiki/Manual:Hooks/BlockIpComplete by MW 1.4

"... occurs after the request to block (or change block settings of) an IP or user has been processed ..."

◆ onContentHandlerForModelID()

SMW\MediaWiki\Hooks::onContentHandlerForModelID (   $modelId,
$contentHandler 
)

Hook: Occurs when an articleheader is shown

See also
https://www.mediawiki.org/wiki/Manual:Hooks/ContentHandlerForModelID

◆ onDeleteAccount()

SMW\MediaWiki\Hooks::onDeleteAccount (   $user)

◆ onEditPageShowEditFormInitial()

SMW\MediaWiki\Hooks::onEditPageShowEditFormInitial (   $editPage,
  $output 
)

◆ onExtensionTypes()

SMW\MediaWiki\Hooks::onExtensionTypes ( $extTypes)

◆ onFileUpload()

SMW\MediaWiki\Hooks::onFileUpload (   $file,
  $reupload 
)

◆ onGetPreferences()

SMW\MediaWiki\Hooks::onGetPreferences (   $user,
$preferences 
)

◆ onInternalParseBeforeLinks()

SMW\MediaWiki\Hooks::onInternalParseBeforeLinks ( $parser,
$text,
$stripState 
)

Hook: InternalParseBeforeLinks is used to process the expanded wiki code after <nowiki>, HTML-comments, and templates have been treated.

See also
https://www.mediawiki.org/wiki/Manual:Hooks/InternalParseBeforeLinks

◆ onLinksUpdateConstructed()

SMW\MediaWiki\Hooks::onLinksUpdateConstructed (   $linksUpdate)

Hook: LinksUpdateConstructed called at the end of LinksUpdate() construction

See also
https://www.mediawiki.org/wiki/Manual:Hooks/LinksUpdateConstructed

◆ onLoadExtensionSchemaUpdates()

SMW\MediaWiki\Hooks::onLoadExtensionSchemaUpdates (   $databaseUpdater)

◆ onMaintenanceUpdateAddParams()

SMW\MediaWiki\Hooks::onMaintenanceUpdateAddParams ( $params)

◆ onNewRevisionFromEditComplete()

SMW\MediaWiki\Hooks::onNewRevisionFromEditComplete (   $wikiPage,
  $revision,
  $baseId,
  $user 
)

Hook: NewRevisionFromEditComplete called when a revision was inserted due to an edit

See also
https://www.mediawiki.org/wiki/Manual:Hooks/NewRevisionFromEditComplete

◆ onOutputPageCheckLastModified()

SMW\MediaWiki\Hooks::onOutputPageCheckLastModified ( $lastModified)

Hook: When checking if the page has been modified since the last visit

See also
https://www.mediawiki.org/wiki/Manual:Hooks/OutputPageCheckLastModified

◆ onOutputPageParserOutput()

SMW\MediaWiki\Hooks::onOutputPageParserOutput ( $outputPage,
  $parserOutput 
)

Hook: Called after parse, before the HTML is added to the output

See also
https://www.mediawiki.org/wiki/Manual:Hooks/OutputPageParserOutput

◆ onParserAfterTidy()

SMW\MediaWiki\Hooks::onParserAfterTidy ( $parser,
$text 
)

Hook: ParserAfterTidy to add some final processing to the fully-rendered page output

See also
https://www.mediawiki.org/wiki/Manual:Hooks/ParserAfterTidy

◆ onParserFirstCallInit()

SMW\MediaWiki\Hooks::onParserFirstCallInit ( $parser)
See also
https://www.mediawiki.org/wiki/Manual:Hooks/ParserFirstCallInit

Support for <section> ... </section>

◆ onParserOptionsRegister()

SMW\MediaWiki\Hooks::onParserOptionsRegister ( $defaults,
$inCacheKey 
)

◆ onPersonalUrls()

SMW\MediaWiki\Hooks::onPersonalUrls ( array &  $personal_urls,
  $title,
  $skinTemplate 
)

◆ onRejectParserCacheValue()

SMW\MediaWiki\Hooks::onRejectParserCacheValue (   $value,
  $page,
  $popts 
)

◆ onResourceLoaderGetConfigVars()

SMW\MediaWiki\Hooks::onResourceLoaderGetConfigVars ( $vars)

◆ onResourceLoaderTestModules()

SMW\MediaWiki\Hooks::onResourceLoaderTestModules ( $testModules,
$resourceLoader 
)

◆ onSidebarBeforeOutput()

SMW\MediaWiki\Hooks::onSidebarBeforeOutput (   $skin,
$sidebar 
)

Hook: Called by Skin when building the toolbox array and returning it for the skin to output.

See also
https://www.mediawiki.org/wiki/Manual:Hooks/SidebarBeforeOutput

◆ onSkinAfterContent()

SMW\MediaWiki\Hooks::onSkinAfterContent ( $data,
  $skin = null 
)

Hook: Allows extensions to add text after the page content and article metadata.

See also
https://www.mediawiki.org/wiki/Manual:Hooks/SkinAfterContent

◆ onSkinTemplateNavigation()

SMW\MediaWiki\Hooks::onSkinTemplateNavigation ( $skinTemplate,
$links 
)

◆ onSoftwareInfo()

SMW\MediaWiki\Hooks::onSoftwareInfo ( $software)

◆ onSpecialSearchProfileForm()

SMW\MediaWiki\Hooks::onSpecialSearchProfileForm (   $specialSearch,
$form,
  $profile,
  $term,
  $opts 
)

◆ onSpecialSearchProfiles()

SMW\MediaWiki\Hooks::onSpecialSearchProfiles ( array &  $profiles)

◆ onSpecialSearchResultsPrepend()

SMW\MediaWiki\Hooks::onSpecialSearchResultsPrepend (   $specialSearch,
  $outputPage,
  $term 
)

Hook: Called immediately before returning HTML on the search results page

See also
https://www.mediawiki.org/wiki/Manual:Hooks/SpecialSearchResultsPrepend

◆ onSpecialStatsAddExtra()

SMW\MediaWiki\Hooks::onSpecialStatsAddExtra ( $extraStats,
IContextSource  $context 
)

Hook: Add extra statistic at the end of Special:Statistics

See also
https://www.mediawiki.org/wiki/Manual:Hooks/SpecialStatsAddExtra

◆ onTitleIsAlwaysKnown()

SMW\MediaWiki\Hooks::onTitleIsAlwaysKnown (   $title,
$result 
)

◆ onTitleIsMovable()

SMW\MediaWiki\Hooks::onTitleIsMovable (   $title,
$isMovable 
)

◆ onTitleMoveComplete()

SMW\MediaWiki\Hooks::onTitleMoveComplete (   $oldTitle,
  $newTitle,
  $user,
  $oldId,
  $newId 
)

Hook: TitleMoveComplete occurs whenever a request to move an article is completed

See also
https://www.mediawiki.org/wiki/Manual:Hooks/TitleMoveComplete

◆ onTitleQuickPermissions()

SMW\MediaWiki\Hooks::onTitleQuickPermissions (   $title,
  $user,
  $action,
$errors,
  $rigor,
  $short 
)
See also
https://www.mediawiki.org/wiki/Manual:Hooks/TitleQuickPermissions

"...Quick permissions are checked first in the Title::checkQuickPermissions function. Quick permissions are the most basic of permissions needed to perform an action ..."

◆ onUnblockUserComplete()

SMW\MediaWiki\Hooks::onUnblockUserComplete (   $block,
  $performer 
)
See also
https://www.mediawiki.org/wiki/Manual:Hooks/UnblockUserComplete by MW 1.29

"... occurs after the request to unblock an IP or user has been processed ..."

◆ onUserGroupsChanged()

SMW\MediaWiki\Hooks::onUserGroupsChanged (   $user)
See also
https://www.mediawiki.org/wiki/Manual:Hooks/UserGroupsChanged by MW 1.26

"... called after user groups are changed ..."

◆ register()

SMW\MediaWiki\Hooks::register ( $vars)
Since
2.1

◆ registerEarly()

static SMW\MediaWiki\Hooks::registerEarly ( array &  $vars)
static
Since
3.0
Parameters
array&$vars

CanonicalNamespaces initialization

Note
According to T104954 registration via wgExtensionFunctions can be too late and should happen before that in case RequestContext::getLanguage invokes Language::getNamespaces before the wgExtensionFunctions execution.
See also
https://phabricator.wikimedia.org/T104954#2391291
https://www.mediawiki.org/wiki/Manual:Hooks/CanonicalNamespaces 34383

To add to or remove pages from the special page list. This array has the same structure as $wgSpecialPages.

See also
https://www.mediawiki.org/wiki/Manual:Hooks/SpecialPage_initList

#2813

Called when ApiMain has finished initializing its module manager. Can be used to conditionally register API modules.

#2813

◆ registerExtensionCheck()

static SMW\MediaWiki\Hooks::registerExtensionCheck ( array &  $vars)
static

Allow to show a message on Special:Version when it is clear that the extension was loaded but not enabled.

Since
3.1
Parameters
array&$vars

The documentation for this class was generated from the following file:

About | General disclaimer | Privacy policy