Hooks

This document contains details about event handlers (also known as Hooks) provided by Semantic MediaWiki to enable users to extent and integrate custom specific solutions.

Available hooks

Implementing a hook should be made in consideration of the expected performance impact for the front-end (additional DB read/write transactions etc.) and/or the back-end (prolonged job backlog etc.) process.

Setup and registry

• SMW::DataType::initTypes to add additional DataType support
• SMW::Property::initProperties to add additional predefined properties
• SMW::Constraint::initConstraints to add custom constraints
• SMW::GetPreferences to add extra preferences that are ordered on the Semantic MediaWiki user preference tab
• SMW::Setup::AfterInitializationComplete to modify global configuration after initialization of Semantic MediaWiki is completed
• SMW::Settings::BeforeInitializationComplete to modify the Semantic MediaWiki configuration before the initialization is completed
• SMW::Event::RegisterEventListeners to register additional event listeners
• [SMW::Listener::ChangeListener::RegisterPropertyChangeListeners][hook.listener.registerpropertychangelisteners] allows to register and listen to individual property changes

Store

• SMW::SQLStore::BeforeDeleteSubjectComplete is called before the deletion of a subject is completed
• SMW::SQLStore::AfterDeleteSubjectComplete is called after the deletion of a subject is completed
• SMW::SQLStore::BeforeChangeTitleComplete is called before change to a subject is completed
• SMW::SQLStore::BeforeDataRebuildJobInserts to add update jobs while running the rebuild process
• SMW::SQLStore::BeforeDataUpdateComplete to extend the SemanticData object before the update is completed
• SMW::SQLStore::AfterDataUpdateComplete to process information after an update has been completed
• SMW::Store::BeforeDataUpdateComplete to extend the SemanticData object before the update is completed
• SMW::Store::AfterDataUpdateComplete to process information after an update has been completed

Property tables

• SMW::SQLStore::AddCustomFixedPropertyTables to add fixed property table definitions
• SMW::SQLStore::updatePropertyTableDefinitions to add additional table definitions during initialization
• SMW::SQLStore::EntityReferenceCleanUpComplete to process information about an entity where the clean-up has been finalized

Installer

• SMW::SQLStore::Installer::BeforeCreateTablesComplete to add additional table indices
• SMW::SQLStore::Installer::AfterCreateTablesComplete to add extra tables after the creation process as been finalized
• SMW::SQLStore::Installer::AfterDropTablesComplete to remove extra tables after the drop process as been finalized

Query

• SMW::Store::BeforeQueryResultLookupComplete to return a QueryResult object before the standard selection process is started and allows to suppress the standard selection process completely by returning false
• SMW::Store::AfterQueryResultLookupComplete to manipulate a QueryResult after the selection process

Parser, annotations, and revision

• SMW::Parser::BeforeMagicWordsFinder to extend the magic words list that the InTextAnnotationParser should inspect on a given text section
• SMW::Parser::AfterLinksProcessingComplete to add additional annotation parsing after InTextAnnotationParser has finished the processing of standard annotation links (e.g. [[...::...]])
• SMW::Parser::ParserAfterTidyPropertyAnnotationComplete allows to add additional PropertyAnnotator as part of the ParserAfterTidy after default annotators have been executed
• SMW::FileUpload::BeforeUpdate to add extra annotations on a FileUpload event before the Store update is triggered
• SMW::RevisionGuard::ChangeRevision to forcibly change a revision used during content parsing
• SMW::RevisionGuard::ChangeRevisionID to forcibly change the revision ID as in case of the Factbox when building the content.
• SMW::RevisionGuard::IsApprovedRevision to define whether a revision is approved or needs to be suppressed.
• SMW::RevisionGuard::ChangeFile to forcibly change the file version used

Miscellaneous

• SMW::Factbox::BeforeContentGeneration to replace or amend text elements shown in a Factbox
• SMW::Browse::AfterIncomingPropertiesLookupComplete to extend the incoming properties display for Special:Browse
• SMW::Browse::BeforeIncomingPropertyValuesFurtherLinkCreate to replace the standard SearchByProperty with a custom link in Special:Browse to an extended list of results (return false to replace the link)
• SMW::Browse::AfterDataLookupComplete to extend the HTML with data displayed on Special:Browse
• SMW::Admin::TaskHandlerFactory to extend available TaskHandler used in the Special:SemanticMediaWiki dashboard
• SMW::ResultFormat::OverrideDefaultFormat to override the default result format handling
• SMW::Job::AfterUpdateDispatcherJobComplete to add additional update jobs for a property and related subjects
• SMW::Exporter::Controller::AddExpData to add additional RDF data for a selected subject
• SMW::Maintenance::AfterUpdateEntityCollationComplete runs after the updateEntityCollection.php script has finished processing the update of entity collation changes

Deprecated hooks

• smwInitDatatypes (since 1.9)
• smwInitProperties (since 2.1)
• smwShowFactbox (since 2.1)
• smwRefreshDataJobs (since 2.3)
• smwUpdatePropertySubjects (since 1.9)
• smwAddToRDFExport (since 3.0)
• SMWSQLStore3::updateDataBefore (since 3.1)
• SMWSQLStore3::updateDataAfter (since 2.3)
• SMWStore::updateDataBefore (since 3.1)
• SMWStore::updateDataAfter (since 3.1)
• SMWResultFormat (since 3.1)

See also

mws:Manual:Hooks describes how to use hooks in a MediaWiki environment Architecture guide with a general introduction on SMW's architecture

Programmer's guide some general guidelines for developers Original file describing SMW Hooks (from github)