Hooks PHP

Table of Contents

• Repo
  • WikibaseRepoDataTypes
  • WikibaseRepoEntityTypes
  • WikibaseTextForSearchIndex
  • WikibaseContentModelMapping
  • WikibaseRepoEntityNamespaces
  • WikibaseRebuildData (DEPRECATED)
  • WikibaseDeleteData (DEPRECATED)
  • WikibaseChangeNotification
  • WikibaseContentLanguages
  • GetEntityContentModelForTitle
  • WikibaseRepoOnParserOutputUpdaterConstruction
  • GetEntityByLinkedTitleLookup
  • WikibaseSearchEntitiesEngines
• Client
  • WikibaseClientDataTypes
  • WikibaseClientEntityTypes
  • WikibaseHandleChanges
  • WikibaseHandleChange
  • WikibaseClientSiteLinksForItem
  • WikibaseClientEntityNamespaces

This file describes hooks defined by the Wikibase extensions.

See https://www.mediawiki.org/wiki/Manual:Hooks for general information on hooks.

Repo

WikibaseRepoDataTypes

Called when constructing the top-level WikibaseRepo factory May be used to define additional data types. See also the WikibaseClientDataTypes hook.

Hook handlers may add additional definitions. See datatypes documentation for details.

Parameters:

• &$dataTypeDefinitions
  • the array of data type definitions, as defined by WikibaseRepo.datatypes.php.

WikibaseRepoEntityTypes

Called when constructing the top-level WikibaseRepo factory May be used to define additional entity types. See also the WikibaseClientEntityTypes hook.

Hook handlers may add additional definitions. See entitytypes documentation for details.

Parameters:

• &$entityTypeDefinitions
  • the array of entity type definitions, as defined by WikibaseLib.entitytypes.php.

WikibaseTextForSearchIndex

Called by EntityContent::getTextForSearchIndex() to allow extra text to be passed to the search engine for indexing. If the hook function returns false, no text at all will be passed to the search index.

Parameters:

• $entity
  • EntityContent to be indexed
• &$text
  • The text to pass to the indexed (to be modified).

WikibaseContentModelMapping

Called by WikibaseRepo::getContentModelMappings() to allow additional mappings between Entity types and content model identifiers to be defined.

Parameters:

• &$map
  • An associative array mapping Entity types to content model ids.

WikibaseRepoEntityNamespaces

Called by WikibaseRepo::getEntityNamespaceLookup() to allow additional mappings between Entity types and namespace IDs to be defined.

Parameters:

• &$map
  • An associative array mapping Entity types to namespace ids.

WikibaseRebuildData (DEPRECATED)

Parameters:

• $report
  • A closure that can be called with a string to report that messages.

WikibaseDeleteData (DEPRECATED)

Parameters:

• $report
  • A closure that can be called with a string to report that messages.

WikibaseChangeNotification

Triggered from ChangeNotifier via a HookChangeTransmitter to notify any listeners of changes to entities.

For performance reasons, does not include statement, description and alias diffs (see T113468, T163465).

Parameters:

• $change
  • The Change object representing the change.

WikibaseContentLanguages

Called by[ WikibaseRepo::getContentLanguages()], which in turn is called by some other getters, to define the content languages per context.

Parameters:

• &$map
  • An associative array mapping contexts ('term', 'monolingualtext', extension-specific…) to ContentLanguage objects.

GetEntityContentModelForTitle

Called by EntityContentFactory to see what is the entity content type of the Title. Extensions can override it so entity content type does not equal page content type.

Parameters:

• $title
  • Title object for the page
• &$contentType
  • Content type for the page. Extensions can override this.

WikibaseRepoOnParserOutputUpdaterConstruction

Allows extensions to register extra EntityParserOutputUpdater implementations.

Parameters:

• $statementUpdater
• &$entityUpdaters

GetEntityByLinkedTitleLookup

Allows extensions to add custom EntityByLinkedTitleLookup services.

Parameters:

• &$lookup

WikibaseSearchEntitiesEngines

Parameters:

• $repo
• &$engines

Client

WikibaseClientDataTypes

Called when constructing the top-level WikibaseClient factory May be used to define additional data types See also the WikibaseRepoDataTypes hook.

Hook handlers may add additional definitions. See the datatypes documentation for details.

Parameters:

• &$dataTypeDefinitions
  • The array of data type definitions, as defined by WikibaseClient.datatypes.php.

WikibaseClientEntityTypes

Called when constructing the top-level WikibaseClient factory May be used to define additional entity types. See also the WikibaseRepoEntityTypes hook.

Hook handlers may add additional definitions. See entitytypes documentation for details.

Parameters:

• &$entityTypeDefinitions
  • The array of entity type definitions, as defined by WikibaseLib.entitytypes.php.

WikibaseHandleChanges

Called by ChangeHandler::handleChange() to allow pre-processing of changes.

Parameters:

• $changes
  • A list of Change objects
• $rootJobParams
  • Any relevant root job parameters to be inherited by child jobs.

WikibaseHandleChange

Called by ChangeHandler::handleChange() to allow alternative processing of changes.

Parameters:

• $change
  • A Change object
• $rootJobParams
  • Any relevant root job parameters to be inherited by child jobs.

WikibaseClientSiteLinksForItem

Called by OtherProjectsSidebarGenerator to allow altering the sitelinks used in language links and the other projects sidebar. Only called in case the page we are on is linked with an item.

Parameters:

• $item
  • Item the page is linked with.
• &$siteLinks
  • Array containing the site links to display indexed by site ID.
• $usageAccumulator
  • A [UsageAccumulator] to track the usages of Wikibase entities done by the hook handlers.

WikibaseClientEntityNamespaces

Called by WikibaseClient::getEntityNamespaceLookup() to allow additional mappings between Entity types and namespace IDs to be defined.

Parameters:

• &$map
  • An associative array mapping Entity types to namespace ids.