This class provides an implementation of the hook interfaces used by the core Action API, forwarding hook calls to HookContainer for dispatch to extensions. More...

Collaboration diagram for MediaWiki\Api\ApiHookRunner:

[legend]

Public Member Functions

__construct (HookContainer $container)

onAPIAfterExecute ( $module)

This hook is called after calling the execute() method of an API module.Use this hook to extend core API modules.

Since: 1.35

Parameters

ApiBase $module

Returns: bool|void True or no return value to continue or false to abort

onApiCheckCanExecute ( $module, $user, &$message)

This hook is called during ApiMain::checkExecutePermissions.Use this hook to further authenticate and authorize API clients before executing the module.

Since: 1.35

Parameters

ApiBase	$module
User	$user	Current user
MessageSpecifier \| string \| array	&$message	API message to die with. Specific values accepted depend on the MediaWiki version: 1.43+: MessageSpecifier, string message key, or key+parameters array to pass to ApiBase::dieWithError(). 1.29+: IApiMessage, Message, string message key, or key+parameters array to pass to ApiBase::dieWithError(). 1.27+: IApiMessage, or a key or key+parameters in ApiBase::$messageMap. Earlier: A key or key+parameters in ApiBase::$messageMap.

Returns: bool|void True or no return value to continue, or false and set a message to cancel the request

See also: ApiMessage::create() for how the $message parameter is interpreted.; ApiQueryCheckCanExecuteHook for query modules.; RestCheckCanExecuteHook for REST API modules.

onApiDeprecationHelp (&$msgs)

Use this hook to add messages to the 'deprecation-help' warning generated from ApiBase::addDeprecation().

Since: 1.35

Parameters

Message[] &$msgs Messages to include in the help. Multiple messages will be joined with spaces.

Returns: bool|void True or no return value to continue or false to abort

onApiFeedContributions__feedItem ( $row, $context, &$feedItem)

Use this hook to convert the result of ContribsPager into a MediaWiki\Feed\FeedItem instance that ApiFeedContributions can consume.Implementors of this hook may cancel the hook to signal that the item is not viewable in the provided context.

Parameters

stdClass	$row	A row of data from ContribsPager. The set of data returned by ContribsPager can be adjusted by handling the ContribsPager::reallyDoQuery hook.
IContextSource	$context
\\MediaWiki\\Feed\\FeedItem \| null	&$feedItem	Set this to a FeedItem instance if the callback can handle the provided row. This is provided to the hook as a null, if it is non-null then another callback has already handled the hook.

Returns: bool|void True or no return value to continue or false to abort

Since: 1.35

onApiFormatHighlight ( $context, $text, $mime, $format)

Use this hook to syntax-highlight API pretty-printed output.

Since: 1.35

Parameters

IContextSource	$context
string	$text	Text to be highlighted
string	$mime	MIME type of $text
string	$format	API format code for $text

Returns: bool|void True or no return value to continue, or false and add output to $context->getOutput() to highlight

onAPIGetAllowedParams ( $module, &$params, $flags)

Use this hook to modify a module's parameters.

Since: 1.35

Parameters

ApiBase	$module
array	&$params	Array of parameters
int	$flags	Zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP

Returns: bool|void True or no return value to continue or false to abort

onAPIGetDescriptionMessages ( $module, &$msg)

Use this hook to modify a module's help message.

Since: 1.35

Parameters

ApiBase	$module
Message[]	&$msg

Returns: bool|void True or no return value to continue or false to abort

onAPIGetParamDescriptionMessages ( $module, &$msg)

Use this hook to modify a module's parameter descriptions.

Since: 1.35

Parameters

ApiBase	$module
Message[][]	&$msg

Returns: bool|void True or no return value to continue or false to abort

onAPIHelpModifyOutput ( $module, &$help, $options, &$tocData)

Use this hook to modify an API module's help output.

Since: 1.35

Parameters

ApiBase	$module
string[]	&$help	Array of HTML strings to be joined for the output
array	$options	Array of formatting options passed to ApiHelp::getHelp
array	&$tocData	If a TOC is being generated, this array has keys as anchors in the page and values as for SectionMetadata::fromLegacy().

Returns: bool|void True or no return value to continue or false to abort

onApiLogFeatureUsage ( $feature, array $clientInfo)

This hook is called after calling the logFeatureUsage() method of an API module.Use this hook to extend core API modules.

Since: 1.43

Parameters

string	$feature
	array<string,mixed>	$clientInfo

Returns: void

onApiMain__moduleManager ( $moduleManager)

This hook is called when ApiMain has finished initializing its module manager.Use this hook to conditionally register API modules.

Since: 1.35

Parameters

ApiModuleManager $moduleManager

Returns: bool|void True or no return value to continue or false to abort

onApiMain__onException ( $apiMain, $e)

This hook is called by ApiMain::executeActionWithErrorHandling() when an exception is thrown during API action execution.

Since: 1.35

Parameters

ApiMain	$apiMain	Calling ApiMain instance
Throwable	$e

Returns: bool|void True or no return value to continue or false to abort

onApiMakeParserOptions ( $options, $title, $params, $module, &$reset, &$suppressCache)

This hook is called from ApiParse and ApiExpandTemplates to allow extensions to adjust the ParserOptions before parsing.

Since: 1.35

Parameters

ParserOptions	$options
Title	$title	Title to be parsed
array	$params	Parameter array for the API module
ApiBase	$module	API module (which is also a ContextSource)
ScopedCallback \| null	&$reset	Set to a ScopedCallback used to reset any hooks after the parse is done
bool	&$suppressCache	Set true if cache should be suppressed

Returns: bool|void True or no return value to continue or false to abort

onApiMaxLagInfo (&$lagInfo)

This hook is called when lag information is being requested via API.Use this hook to override lag information. Generally a hook function should only replace $lagInfo if the new $lagInfo['lag'] is greater than the current $lagInfo['lag'].

Since: 1.35

Parameters

array

&$lagInfo

Maximum lag information array. Fields in the array are:

lag: number of seconds of lag
host: host name on which the lag exists
type: an indication of the type of lag. For example: "db" for database replication lag or "jobqueue" for job queue size converted to pseudo-seconds

You can also add more fields that are returned to the user in the API response.

Returns: void This hook must not abort, it must return no value

onApiOpenSearchSuggest (&$results)

This hook is called when constructing the OpenSearch results.Hooks can alter or append to the array.

Since: 1.35

Parameters

array[]

&$results

Array with integer keys to associative arrays. Keys in associative array:

title: Title object
redirect from: Title or null
extract: Description for this result
extract trimmed: If truthy, the extract will not be trimmed to $wgOpenSearchDescriptionLength.
image: Thumbnail for this result. Value is an array with subkeys source (URL), width, height, alt, and align.
url: URL for the given title

Returns: bool|void True or no return value to continue or false to abort

onApiOptions ( $apiModule, $user, $changes, $resetKinds)

This hook is called by action=options before applying changes to user preferences.

Since: 1.35

Parameters

ApiOptions	$apiModule	Calling ApiOptions object
User	$user	User object whose preferences are being changed
array	$changes	Associative array of preference name => value
string[]	$resetKinds	Array of strings specifying which options kinds to reset See PreferencesFactory::listResetKinds() for possible values.

Returns: bool|void True or no return value to continue or false to abort

onApiParseMakeOutputPage ( $module, $output)

This hook is called when preparing the OutputPage object for ApiParse.This is mainly intended for calling OutputPage::addContentOverride() or OutputPage::addContentOverrideCallback().

Since: 1.35

Parameters

ApiBase	$module	ApiBase (which is also a ContextSource)
OutputPage	$output

Returns: bool|void True or no return value to continue or false to abort

onApiQuery__moduleManager ( $moduleManager)

This hook is called when ApiQuery has finished initializing its module manager.Use this hook to conditionally register API query modules.

Since: 1.35

Parameters

ApiModuleManager $moduleManager

Returns: bool|void True or no return value to continue or false to abort

onAPIQueryAfterExecute ( $module)

This hook is called after calling the execute() method of an action=query submodule.Use this hook to extend core API modules.

Since: 1.35

Parameters

ApiBase $module

Returns: bool|void True or no return value to continue or false to abort

onApiQueryBaseAfterQuery ( $module, $result, &$hookData)

This hook is called for (some) API query modules after the database query has returned.An API query module wanting to use this hook should see the ApiQueryBase::select() and ApiQueryBase::processRow() documentation.

Since: 1.35

Parameters

ApiQueryBase	$module	Module in question
IResultWrapper	$result	ResultWrapper
array	&$hookData	Array that was passed to the ApiQueryBaseBeforeQuery hook and will be passed to the ApiQueryBaseProcessRow hook, intended for inter-hook communication

Returns: bool|void True or no return value to continue or false to abort

onApiQueryBaseBeforeQuery ( $module, &$tables, &$fields, &$conds, &$query_options, &$join_conds, &$hookData)

This hook is called for (some) API query modules before a database query is made.WARNING: It would be very easy to misuse this hook and break the module! Any joins added must join on a unique key of the target table unless you really know what you're doing. An API query module wanting to use this hook should see the ApiQueryBase::select() and ApiQueryBase::processRow() documentation.

Since: 1.35

Parameters

ApiQueryBase	$module	Module in question
array	&$tables	Array of tables to be queried
array	&$fields	Array of columns to select
array	&$conds	Array of WHERE conditionals for query
array	&$query_options	Array of options for the database request
array	&$join_conds	Join conditions for the tables
array	&$hookData	Array that will be passed to the ApiQueryBaseAfterQuery and ApiQueryBaseProcessRow hooks, intended for inter-hook communication.

Returns: bool|void True or no return value to continue or false to abort

onApiQueryBaseProcessRow ( $module, $row, &$data, &$hookData)

This hook is called for (some) API query modules as each row of the database result is processed.An API query module wanting to use this hook should see the ApiQueryBase::select() and ApiQueryBase::processRow() documentation.

Since: 1.35

Parameters

ApiQueryBase	$module	Module in question
stdClass	$row	Database result row
array	&$data	Array to be included in the ApiResult
array	&$hookData	Array that was be passed to the ApiQueryBaseBeforeQuery and ApiQueryBaseAfterQuery hooks, intended for inter-hook communication

Returns: bool|void True or no return value to continue, or false to stop processing the result set

onApiQueryCheckCanExecute ( $modules, $authority, &$message)

This hook is called during at the beginning of ApiQuery::execute and can be used to prevent execution of query submodules.

Since: 1.44

Parameters

ApiQueryBase[]	$modules
Authority	$authority	Current user
MessageSpecifier \| string \| array	&$message	API message to die with.

Returns: bool|void True or no return value to continue, or false and set a message to cancel the request

See also: ApiMessage::create() for how the $message parameter is interpreted.; ApiCheckCanExecuteHook for non-query modules.

onAPIQueryGeneratorAfterExecute ( $module, $resultPageSet)

This hook is called after calling the executeGenerator() method of an action=query submodule.Use this hook to extend core API modules.

Since: 1.35

Parameters

ApiBase	$module
ApiPageSet	$resultPageSet

Returns: bool|void True or no return value to continue or false to abort

onAPIQuerySiteInfoGeneralInfo ( $module, &$results)

Use this hook to add extra information to the site's general information.

Since: 1.35

Parameters

ApiQuerySiteinfo	$module	Current ApiQuerySiteinfo module
array	&$results	Array of results, add things here

Returns: bool|void True or no return value to continue or false to abort

onAPIQuerySiteInfoStatisticsInfo (&$results)

Use this hook to add extra information to the site's statistics information.

Since: 1.35

Parameters

array &$results Array of results, add things here

Returns: bool|void True or no return value to continue or false to abort

onApiQueryTokensRegisterTypes (&$salts)

Use this hook to add additional token types to action=query&meta=tokens.Note that most modules will probably be able to use the CSRF token instead of creating their own token types.

Since: 1.35

Parameters

array &$salts [ type => salt to pass to User::getEditToken(), or array of salt and key to pass to Session::getToken() ]

Returns: bool|void True or no return value to continue or false to abort

onApiQueryWatchlistExtractOutputData ( $module, $watchedItem, $recentChangeInfo, &$vals)

Use this hook to extract row data for ApiQueryWatchlist.

Since: 1.35

Parameters

ApiQueryWatchlist	$module
WatchedItem	$watchedItem
array	$recentChangeInfo	Array of recent change info data
array	&$vals	Associative array of data to be output for the row

Returns: bool|void True or no return value to continue or false to abort

onApiQueryWatchlistPrepareWatchedItemQueryServiceOptions ( $module, $params, &$options)

Use this hook to populate the options to be passed from ApiQueryWatchlist to WatchedItemQueryService.

Since: 1.35

Parameters

ApiQueryWatchlist	$module
array	$params	Array of parameters, as would be returned by $module->extractRequestParams()
array	&$options	Array of options for WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo()

Returns: bool|void True or no return value to continue or false to abort

onApiRsdServiceApis (&$apis)

Use this hook to add or remove APIs from the RSD services list.Each service should have its own entry in the $apis array and have a unique name, passed as key for the array that represents the service data. In this data array, the key-value-pair identified by the apiLink key is required.

Since: 1.35

Parameters

array &$apis Array of services

Returns: bool|void True or no return value to continue or false to abort

onApiValidatePassword ( $module, &$r)

This hook is called from ApiValidatePassword.

Since: 1.35

Parameters

ApiValidatePassword	$module
array	&$r	Result array

Returns: bool|void True or no return value to continue or false to abort

onArticleParserOptions (Article $article, ParserOptions $popts)

This hook is called before parsing wikitext for an article, and allows setting particular parser options based on title, user preferences, etc.

Since: 1.36

Parameters

Article	$article	Article about to be parsed
ParserOptions	$popts	Mutable parser options

Returns: bool|void True or no return value to continue or false to abort

onChangeAuthenticationDataAudit ( $req, $status)

This hook is called when a user changes their password.No return data is accepted; this hook is for auditing only.

Since: 1.35

Parameters

AuthenticationRequest	$req	Object describing the change (and target user)
StatusValue	$status	StatusValue with the result of the action

Returns: bool|void True or no return value to continue or false to abort

onEditFormPreloadText (&$text, $title)

Use this hook to populate the edit form when creating pages.

Since: 1.35

Parameters

string	&$text	Text to preload with
Title	$title	Page being created

Returns: bool|void True or no return value to continue or false to abort

onFileUndeleteComplete ( $title, $fileVersions, $user, $reason)

This hook is called when a file is undeleted.

Since: 1.35

Parameters

Title	$title	Title object for the file
int[]	$fileVersions	Array of undeleted filearchive IDs. Empty if all versions were restored.
User	$user	User who performed the undeletion
string	$reason

Returns: bool|void True or no return value to continue or false to abort

onGetLinkColours ( $pagemap, &$classes, $title)

Use this hook to modify the CSS class of an array of page links.

Since: 1.35

Parameters

string[]	$linkcolour_ids	Array of prefixed DB keys of the pages linked to, indexed by page_id
string[]	&$colours	(Output) Array of CSS classes, indexed by prefixed DB keys
Title	$title	Title of the page being parsed, on which the links will be shown

Returns: bool|void True or no return value to continue or false to abort

onImportSources (&$importSources)

This hook is called when reading from the $wgImportSources configuration variable.This can be used to lazy-load the import sources list.

Since: 1.35

Parameters

array &$importSources The value of $wgImportSources. Modify as necessary. See \MediaWiki\MainConfigSchema::ImportSources.

Returns: bool|void True or no return value to continue or false to abort

onLanguageLinks ( $title, &$links, &$linkFlags)

Use this hook to manipulate a page's language links.This hook is called in various places to allow extensions to define the effective language links for a page.

Since: 1.35

Parameters

Title	$title
string[]	&$links	Array with elements of the form "language:title" in the order that they will be output
array	&$linkFlags	Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles.

Returns: bool|void True or no return value to continue or false to abort

onOutputPageBeforeHTML ( $out, &$text)

This hook is called when a page has been processed by the parser and the resulting HTML is about to be displayed.

Since: 1.35

Parameters

OutputPage	$out	OutputPage object that corresponds to the page
string	&$text	Text that will be displayed, in HTML

Returns: bool|void This hook must not abort, it must return true or null.

onOutputPageCheckLastModified (&$modifiedTimes, $out)

This hook is called when checking if the page has been modified since the last visit.

Since: 1.35

Parameters

string[]	&$modifiedTimes	Array of timestamps. The following keys are set: page, user, epoch.
OutputPage	$out	since 1.28

Returns: bool|void True or no return value to continue or false to abort

onRequestHasSameOriginSecurity ( $request)

Use this hook to determine if the request is somehow flagged to lack same-origin security.Note that if the "somehow" involves HTTP headers, you'll probably need to make sure the header is varied on.

Since: 1.35

Parameters

WebRequest $request

Returns: bool|void True or no return value to continue, or false to indicate a lack of same-origin security

onTempUserCreatedRedirect (Session $session, UserIdentity $user, string $returnTo, string $returnToQuery, string $returnToAnchor, &$redirectUrl)

This hook is called after an action causes a temporary user to be created or after the first successful edit for a temporary account.The handler may modify the redirect URL.To differentiate between invocations of this hook where a) the account was created in the current request and b) the account existed, but made a first successful edit, one can examine the registration date of the account.

Since: 1.39

Parameters

Session	$session
UserIdentity	$user
string	$returnTo	The prefixed DB key of the title to redirect to
string	$returnToQuery	An extra query part
string	$returnToAnchor	Either an empty string or a fragment beginning with "#"
string	&$redirectUrl	The URL to redirect to

Returns: bool|null

onUserLoginComplete ( $user, &$inject_html, $direct)

Use this hook to show custom content after a user has logged in via the web interface.This includes both login and signup. It's also called by the action=login API (but not action=clientlogin or action=createaccount) for legacy reasons.For functionality that needs to run after any login (API or web) use UserLoggedIn.Before 1.42 this hook was also called when the user visited the login page with a returnto parameter while already logged in. Code that needs to run in that situation should use the PostLoginRedirect hook instead.

Since: 1.35

Parameters

User	$user	The user object that was created on login
string	&$inject_html	Any HTML to inject after the "logged in" message. (Setting it to a non-empty value will also prevent redirects: instead of the user being sent back to the page indicated by the returnto URL parameter, they will see a success page with $inject_html and a link to the returnto page.) On signup, the BeforeWelcomeCreation hook can further modify this value.
bool	$direct	(bool) Unused, always true. Before 1.42, it was false when the hook was called in situations other than a successful login or signup; since 1.42 those don't happen anymore.

Returns: bool|void True or no return value to continue or false to abort

See also: BeforeWelcomeCreationHook::onBeforeWelcomeCreation

onUserLogoutComplete ( $user, &$inject_html, $oldName)

This hook is called after a user has logged out.

Since: 1.35

Parameters

User	$user	the user object after logout (won't have name, ID, etc.)
string	&$inject_html	Any HTML to inject after the "logged out" message.
string	$oldName	name of the user before logout (string)

Returns: bool|void True or no return value to continue or false to abort

Detailed Description

This class provides an implementation of the hook interfaces used by the core Action API, forwarding hook calls to HookContainer for dispatch to extensions.

To get an instance, use ApiBase::getHookRunner().

Definition at line 18 of file ApiHookRunner.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Api\ApiHookRunner::__construct ( HookContainer $container )

Definition at line 66 of file ApiHookRunner.php.

Member Function Documentation

◆ onAPIAfterExecute()

MediaWiki\Api\ApiHookRunner::onAPIAfterExecute ( $module )

This hook is called after calling the execute() method of an API module.Use this hook to extend core API modules.

Since: 1.35

Parameters

ApiBase $module

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\APIAfterExecuteHook.

Definition at line 71 of file ApiHookRunner.php.

◆ onApiCheckCanExecute()

MediaWiki\Api\ApiHookRunner::onApiCheckCanExecute	(		$module,
			$user,
		&	$message )

This hook is called during ApiMain::checkExecutePermissions.Use this hook to further authenticate and authorize API clients before executing the module.

Since: 1.35

Parameters

ApiBase	$module
User	$user	Current user
MessageSpecifier \| string \| array	&$message	API message to die with. Specific values accepted depend on the MediaWiki version: 1.43+: MessageSpecifier, string message key, or key+parameters array to pass to ApiBase::dieWithError(). 1.29+: IApiMessage, Message, string message key, or key+parameters array to pass to ApiBase::dieWithError(). 1.27+: IApiMessage, or a key or key+parameters in ApiBase::$messageMap. Earlier: A key or key+parameters in ApiBase::$messageMap.

Returns: bool|void True or no return value to continue, or false and set a message to cancel the request

See also: ApiMessage::create() for how the $message parameter is interpreted.; ApiQueryCheckCanExecuteHook for query modules.; RestCheckCanExecuteHook for REST API modules.

Implements MediaWiki\Api\Hook\ApiCheckCanExecuteHook.

Definition at line 79 of file ApiHookRunner.php.

◆ onApiDeprecationHelp()

MediaWiki\Api\ApiHookRunner::onApiDeprecationHelp ( & $msgs )

Use this hook to add messages to the 'deprecation-help' warning generated from ApiBase::addDeprecation().

Since: 1.35

Parameters

Message[] &$msgs Messages to include in the help. Multiple messages will be joined with spaces.

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiDeprecationHelpHook.

Definition at line 87 of file ApiHookRunner.php.

◆ onApiFeedContributions__feedItem()

MediaWiki\Api\ApiHookRunner::onApiFeedContributions__feedItem	(		$row,
			$context,
		&	$feedItem )

Use this hook to convert the result of ContribsPager into a MediaWiki\Feed\FeedItem instance that ApiFeedContributions can consume.Implementors of this hook may cancel the hook to signal that the item is not viewable in the provided context.

Parameters

stdClass	$row	A row of data from ContribsPager. The set of data returned by ContribsPager can be adjusted by handling the ContribsPager::reallyDoQuery hook.
IContextSource	$context
\\MediaWiki\\Feed\\FeedItem \| null	&$feedItem	Set this to a FeedItem instance if the callback can handle the provided row. This is provided to the hook as a null, if it is non-null then another callback has already handled the hook.

Returns: bool|void True or no return value to continue or false to abort

Since: 1.35

Implements MediaWiki\Api\Hook\ApiFeedContributions__feedItemHook.

Definition at line 95 of file ApiHookRunner.php.

◆ onApiFormatHighlight()

MediaWiki\Api\ApiHookRunner::onApiFormatHighlight	(	$context,
		$text,
		$mime,
		$format )

Use this hook to syntax-highlight API pretty-printed output.

Since: 1.35

Parameters

IContextSource	$context
string	$text	Text to be highlighted
string	$mime	MIME type of $text
string	$format	API format code for $text

Returns: bool|void True or no return value to continue, or false and add output to $context->getOutput() to highlight

Implements MediaWiki\Api\Hook\ApiFormatHighlightHook.

Definition at line 103 of file ApiHookRunner.php.

◆ onAPIGetAllowedParams()

MediaWiki\Api\ApiHookRunner::onAPIGetAllowedParams	(		$module,
		&	$params,
			$flags )

Use this hook to modify a module's parameters.

Since: 1.35

Parameters

ApiBase	$module
array	&$params	Array of parameters
int	$flags	Zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\APIGetAllowedParamsHook.

Definition at line 111 of file ApiHookRunner.php.

◆ onAPIGetDescriptionMessages()

MediaWiki\Api\ApiHookRunner::onAPIGetDescriptionMessages	(		$module,
		&	$msg )

Use this hook to modify a module's help message.

Since: 1.35

Parameters

ApiBase	$module
Message[]	&$msg

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\APIGetDescriptionMessagesHook.

Definition at line 119 of file ApiHookRunner.php.

◆ onAPIGetParamDescriptionMessages()

MediaWiki\Api\ApiHookRunner::onAPIGetParamDescriptionMessages	(		$module,
		&	$msg )

Use this hook to modify a module's parameter descriptions.

Since: 1.35

Parameters

ApiBase	$module
Message[][]	&$msg

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\APIGetParamDescriptionMessagesHook.

Definition at line 127 of file ApiHookRunner.php.

◆ onAPIHelpModifyOutput()

MediaWiki\Api\ApiHookRunner::onAPIHelpModifyOutput	(		$module,
		&	$help,
			$options,
		&	$tocData )

Use this hook to modify an API module's help output.

Since: 1.35

Parameters

ApiBase	$module
string[]	&$help	Array of HTML strings to be joined for the output
array	$options	Array of formatting options passed to ApiHelp::getHelp
array	&$tocData	If a TOC is being generated, this array has keys as anchors in the page and values as for SectionMetadata::fromLegacy().

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\APIHelpModifyOutputHook.

Definition at line 135 of file ApiHookRunner.php.

◆ onApiLogFeatureUsage()

MediaWiki\Api\ApiHookRunner::onApiLogFeatureUsage	(		$feature,
		array	$clientInfo )

This hook is called after calling the logFeatureUsage() method of an API module.Use this hook to extend core API modules.

Since: 1.43

Parameters

string	$feature
	array<string,mixed>	$clientInfo

Returns: void

Implements MediaWiki\Api\Hook\ApiLogFeatureUsageHook.

Definition at line 143 of file ApiHookRunner.php.

◆ onApiMain__moduleManager()

MediaWiki\Api\ApiHookRunner::onApiMain__moduleManager ( $moduleManager )

This hook is called when ApiMain has finished initializing its module manager.Use this hook to conditionally register API modules.

Since: 1.35

Parameters

ApiModuleManager $moduleManager

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiMain__moduleManagerHook.

Definition at line 151 of file ApiHookRunner.php.

◆ onApiMain__onException()

MediaWiki\Api\ApiHookRunner::onApiMain__onException	(		$apiMain,
			$e )

This hook is called by ApiMain::executeActionWithErrorHandling() when an exception is thrown during API action execution.

Since: 1.35

Parameters

ApiMain	$apiMain	Calling ApiMain instance
Throwable	$e

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiMain__onExceptionHook.

Definition at line 159 of file ApiHookRunner.php.

◆ onApiMakeParserOptions()

MediaWiki\Api\ApiHookRunner::onApiMakeParserOptions	(		$options,
			$title,
			$params,
			$module,
		&	$reset,
		&	$suppressCache )

This hook is called from ApiParse and ApiExpandTemplates to allow extensions to adjust the ParserOptions before parsing.

Since: 1.35

Parameters

ParserOptions	$options
Title	$title	Title to be parsed
array	$params	Parameter array for the API module
ApiBase	$module	API module (which is also a ContextSource)
ScopedCallback \| null	&$reset	Set to a ScopedCallback used to reset any hooks after the parse is done
bool	&$suppressCache	Set true if cache should be suppressed

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiMakeParserOptionsHook.

Definition at line 167 of file ApiHookRunner.php.

◆ onApiMaxLagInfo()

MediaWiki\Api\ApiHookRunner::onApiMaxLagInfo ( & $lagInfo )

This hook is called when lag information is being requested via API.Use this hook to override lag information. Generally a hook function should only replace $lagInfo if the new $lagInfo['lag'] is greater than the current $lagInfo['lag'].

Since: 1.35

Parameters

array

&$lagInfo

Maximum lag information array. Fields in the array are:

lag: number of seconds of lag
host: host name on which the lag exists
type: an indication of the type of lag. For example: "db" for database replication lag or "jobqueue" for job queue size converted to pseudo-seconds

You can also add more fields that are returned to the user in the API response.

Returns: void This hook must not abort, it must return no value

Implements MediaWiki\Api\Hook\ApiMaxLagInfoHook.

Definition at line 177 of file ApiHookRunner.php.

◆ onApiOpenSearchSuggest()

MediaWiki\Api\ApiHookRunner::onApiOpenSearchSuggest ( & $results )

This hook is called when constructing the OpenSearch results.Hooks can alter or append to the array.

Since: 1.35

Parameters

array[]

&$results

Array with integer keys to associative arrays. Keys in associative array:

title: Title object
redirect from: Title or null
extract: Description for this result
extract trimmed: If truthy, the extract will not be trimmed to $wgOpenSearchDescriptionLength.
image: Thumbnail for this result. Value is an array with subkeys source (URL), width, height, alt, and align.
url: URL for the given title

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiOpenSearchSuggestHook.

Definition at line 186 of file ApiHookRunner.php.

◆ onApiOptions()

MediaWiki\Api\ApiHookRunner::onApiOptions	(	$apiModule,
		$user,
		$changes,
		$resetKinds )

This hook is called by action=options before applying changes to user preferences.

Since: 1.35

Parameters

ApiOptions	$apiModule	Calling ApiOptions object
User	$user	User object whose preferences are being changed
array	$changes	Associative array of preference name => value
string[]	$resetKinds	Array of strings specifying which options kinds to reset See PreferencesFactory::listResetKinds() for possible values.

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiOptionsHook.

Definition at line 194 of file ApiHookRunner.php.

◆ onApiParseMakeOutputPage()

MediaWiki\Api\ApiHookRunner::onApiParseMakeOutputPage	(		$module,
			$output )

This hook is called when preparing the OutputPage object for ApiParse.This is mainly intended for calling OutputPage::addContentOverride() or OutputPage::addContentOverrideCallback().

Since: 1.35

Parameters

ApiBase	$module	ApiBase (which is also a ContextSource)
OutputPage	$output

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiParseMakeOutputPageHook.

Definition at line 202 of file ApiHookRunner.php.

◆ onApiQuery__moduleManager()

MediaWiki\Api\ApiHookRunner::onApiQuery__moduleManager ( $moduleManager )

This hook is called when ApiQuery has finished initializing its module manager.Use this hook to conditionally register API query modules.

Since: 1.35

Parameters

ApiModuleManager $moduleManager

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiQuery__moduleManagerHook.

Definition at line 305 of file ApiHookRunner.php.

◆ onAPIQueryAfterExecute()

MediaWiki\Api\ApiHookRunner::onAPIQueryAfterExecute ( $module )

This hook is called after calling the execute() method of an action=query submodule.Use this hook to extend core API modules.

Since: 1.35

Parameters

ApiBase $module

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\APIQueryAfterExecuteHook.

Definition at line 210 of file ApiHookRunner.php.

◆ onApiQueryBaseAfterQuery()

MediaWiki\Api\ApiHookRunner::onApiQueryBaseAfterQuery	(		$module,
			$result,
		&	$hookData )

This hook is called for (some) API query modules after the database query has returned.An API query module wanting to use this hook should see the ApiQueryBase::select() and ApiQueryBase::processRow() documentation.

Since: 1.35

Parameters

ApiQueryBase	$module	Module in question
IResultWrapper	$result	ResultWrapper
array	&$hookData	Array that was passed to the ApiQueryBaseBeforeQuery hook and will be passed to the ApiQueryBaseProcessRow hook, intended for inter-hook communication

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiQueryBaseAfterQueryHook.

Definition at line 218 of file ApiHookRunner.php.

◆ onApiQueryBaseBeforeQuery()

MediaWiki\Api\ApiHookRunner::onApiQueryBaseBeforeQuery	(		$module,
		&	$tables,
		&	$fields,
		&	$conds,
		&	$query_options,
		&	$join_conds,
		&	$hookData )

This hook is called for (some) API query modules before a database query is made.WARNING: It would be very easy to misuse this hook and break the module! Any joins added must join on a unique key of the target table unless you really know what you're doing. An API query module wanting to use this hook should see the ApiQueryBase::select() and ApiQueryBase::processRow() documentation.

Since: 1.35

Parameters

ApiQueryBase	$module	Module in question
array	&$tables	Array of tables to be queried
array	&$fields	Array of columns to select
array	&$conds	Array of WHERE conditionals for query
array	&$query_options	Array of options for the database request
array	&$join_conds	Join conditions for the tables
array	&$hookData	Array that will be passed to the ApiQueryBaseAfterQuery and ApiQueryBaseProcessRow hooks, intended for inter-hook communication.

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiQueryBaseBeforeQueryHook.

Definition at line 226 of file ApiHookRunner.php.

◆ onApiQueryBaseProcessRow()

MediaWiki\Api\ApiHookRunner::onApiQueryBaseProcessRow	(		$module,
			$row,
		&	$data,
		&	$hookData )

This hook is called for (some) API query modules as each row of the database result is processed.An API query module wanting to use this hook should see the ApiQueryBase::select() and ApiQueryBase::processRow() documentation.

Since: 1.35

Parameters

ApiQueryBase	$module	Module in question
stdClass	$row	Database result row
array	&$data	Array to be included in the ApiResult
array	&$hookData	Array that was be passed to the ApiQueryBaseBeforeQuery and ApiQueryBaseAfterQuery hooks, intended for inter-hook communication

Returns: bool|void True or no return value to continue, or false to stop processing the result set

Implements MediaWiki\Api\Hook\ApiQueryBaseProcessRowHook.

Definition at line 237 of file ApiHookRunner.php.

◆ onApiQueryCheckCanExecute()

MediaWiki\Api\ApiHookRunner::onApiQueryCheckCanExecute	(		$modules,
			$authority,
		&	$message )

This hook is called during at the beginning of ApiQuery::execute and can be used to prevent execution of query submodules.

Since: 1.44

Parameters

ApiQueryBase[]	$modules
Authority	$authority	Current user
MessageSpecifier \| string \| array	&$message	API message to die with.

Returns: bool|void True or no return value to continue, or false and set a message to cancel the request

See also: ApiMessage::create() for how the $message parameter is interpreted.; ApiCheckCanExecuteHook for non-query modules.

Implements MediaWiki\Api\Hook\ApiQueryCheckCanExecuteHook.

Definition at line 245 of file ApiHookRunner.php.

◆ onAPIQueryGeneratorAfterExecute()

MediaWiki\Api\ApiHookRunner::onAPIQueryGeneratorAfterExecute	(		$module,
			$resultPageSet )

This hook is called after calling the executeGenerator() method of an action=query submodule.Use this hook to extend core API modules.

Since: 1.35

Parameters

ApiBase	$module
ApiPageSet	$resultPageSet

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\APIQueryGeneratorAfterExecuteHook.

Definition at line 253 of file ApiHookRunner.php.

◆ onAPIQuerySiteInfoGeneralInfo()

MediaWiki\Api\ApiHookRunner::onAPIQuerySiteInfoGeneralInfo	(		$module,
		&	$results )

Use this hook to add extra information to the site's general information.

Since: 1.35

Parameters

ApiQuerySiteinfo	$module	Current ApiQuerySiteinfo module
array	&$results	Array of results, add things here

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\APIQuerySiteInfoGeneralInfoHook.

Definition at line 261 of file ApiHookRunner.php.

◆ onAPIQuerySiteInfoStatisticsInfo()

MediaWiki\Api\ApiHookRunner::onAPIQuerySiteInfoStatisticsInfo ( & $results )

Use this hook to add extra information to the site's statistics information.

Since: 1.35

Parameters

array &$results Array of results, add things here

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\APIQuerySiteInfoStatisticsInfoHook.

Definition at line 269 of file ApiHookRunner.php.

◆ onApiQueryTokensRegisterTypes()

MediaWiki\Api\ApiHookRunner::onApiQueryTokensRegisterTypes ( & $salts )

Use this hook to add additional token types to action=query&meta=tokens.Note that most modules will probably be able to use the CSRF token instead of creating their own token types.

Since: 1.35

Parameters

array &$salts [ type => salt to pass to User::getEditToken(), or array of salt and key to pass to Session::getToken() ]

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiQueryTokensRegisterTypesHook.

Definition at line 277 of file ApiHookRunner.php.

◆ onApiQueryWatchlistExtractOutputData()

MediaWiki\Api\ApiHookRunner::onApiQueryWatchlistExtractOutputData	(		$module,
			$watchedItem,
			$recentChangeInfo,
		&	$vals )

Use this hook to extract row data for ApiQueryWatchlist.

Since: 1.35

Parameters

ApiQueryWatchlist	$module
WatchedItem	$watchedItem
array	$recentChangeInfo	Array of recent change info data
array	&$vals	Associative array of data to be output for the row

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiQueryWatchlistExtractOutputDataHook.

Definition at line 285 of file ApiHookRunner.php.

◆ onApiQueryWatchlistPrepareWatchedItemQueryServiceOptions()

MediaWiki\Api\ApiHookRunner::onApiQueryWatchlistPrepareWatchedItemQueryServiceOptions	(		$module,
			$params,
		&	$options )

Use this hook to populate the options to be passed from ApiQueryWatchlist to WatchedItemQueryService.

Since: 1.35

Parameters

ApiQueryWatchlist	$module
array	$params	Array of parameters, as would be returned by $module->extractRequestParams()
array	&$options	Array of options for WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo()

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiQueryWatchlistPrepareWatchedItemQueryServiceOptionsHook.

Definition at line 295 of file ApiHookRunner.php.

◆ onApiRsdServiceApis()

MediaWiki\Api\ApiHookRunner::onApiRsdServiceApis ( & $apis )

Use this hook to add or remove APIs from the RSD services list.Each service should have its own entry in the $apis array and have a unique name, passed as key for the array that represents the service data. In this data array, the key-value-pair identified by the apiLink key is required.

Since: 1.35

Parameters

array &$apis Array of services

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiRsdServiceApisHook.

Definition at line 313 of file ApiHookRunner.php.

◆ onApiValidatePassword()

MediaWiki\Api\ApiHookRunner::onApiValidatePassword	(		$module,
		&	$r )

This hook is called from ApiValidatePassword.

Since: 1.35

Parameters

ApiValidatePassword	$module
array	&$r	Result array

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Api\Hook\ApiValidatePasswordHook.

Definition at line 321 of file ApiHookRunner.php.

◆ onArticleParserOptions()

MediaWiki\Api\ApiHookRunner::onArticleParserOptions	(	Article	$article,
		ParserOptions	$popts )

This hook is called before parsing wikitext for an article, and allows setting particular parser options based on title, user preferences, etc.

Since: 1.36

Parameters

Article	$article	Article about to be parsed
ParserOptions	$popts	Mutable parser options

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Page\Hook\ArticleParserOptionsHook.

Definition at line 329 of file ApiHookRunner.php.

◆ onChangeAuthenticationDataAudit()

MediaWiki\Api\ApiHookRunner::onChangeAuthenticationDataAudit	(		$req,
			$status )

This hook is called when a user changes their password.No return data is accepted; this hook is for auditing only.

Since: 1.35

Parameters

AuthenticationRequest	$req	Object describing the change (and target user)
StatusValue	$status	StatusValue with the result of the action

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\SpecialPage\Hook\ChangeAuthenticationDataAuditHook.

Definition at line 337 of file ApiHookRunner.php.

◆ onEditFormPreloadText()

MediaWiki\Api\ApiHookRunner::onEditFormPreloadText	(	&	$text,
			$title )

Use this hook to populate the edit form when creating pages.

Since: 1.35

Parameters

string	&$text	Text to preload with
Title	$title	Page being created

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Hook\EditFormPreloadTextHook.

Definition at line 345 of file ApiHookRunner.php.

◆ onFileUndeleteComplete()

MediaWiki\Api\ApiHookRunner::onFileUndeleteComplete	(	$title,
		$fileVersions,
		$user,
		$reason )

This hook is called when a file is undeleted.

Since: 1.35

Parameters

Title	$title	Title object for the file
int[]	$fileVersions	Array of undeleted filearchive IDs. Empty if all versions were restored.
User	$user	User who performed the undeletion
string	$reason

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Hook\FileUndeleteCompleteHook.

Definition at line 353 of file ApiHookRunner.php.

◆ onGetLinkColours()

MediaWiki\Api\ApiHookRunner::onGetLinkColours	(		$pagemap,
		&	$classes,
			$title )

Use this hook to modify the CSS class of an array of page links.

Since: 1.35

Parameters

string[]	$linkcolour_ids	Array of prefixed DB keys of the pages linked to, indexed by page_id
string[]	&$colours	(Output) Array of CSS classes, indexed by prefixed DB keys
Title	$title	Title of the page being parsed, on which the links will be shown

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Hook\GetLinkColoursHook.

Definition at line 361 of file ApiHookRunner.php.

◆ onImportSources()

MediaWiki\Api\ApiHookRunner::onImportSources ( & $importSources )

This hook is called when reading from the $wgImportSources configuration variable.This can be used to lazy-load the import sources list.

Since: 1.35

Parameters

array &$importSources The value of $wgImportSources. Modify as necessary. See \MediaWiki\MainConfigSchema::ImportSources.

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Hook\ImportSourcesHook.

Definition at line 369 of file ApiHookRunner.php.

◆ onLanguageLinks()

MediaWiki\Api\ApiHookRunner::onLanguageLinks	(		$title,
		&	$links,
		&	$linkFlags )

Use this hook to manipulate a page's language links.This hook is called in various places to allow extensions to define the effective language links for a page.

Since: 1.35

Parameters

Title	$title
string[]	&$links	Array with elements of the form "language:title" in the order that they will be output
array	&$linkFlags	Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles.

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Output\Hook\LanguageLinksHook.

Definition at line 377 of file ApiHookRunner.php.

◆ onOutputPageBeforeHTML()

MediaWiki\Api\ApiHookRunner::onOutputPageBeforeHTML	(		$out,
		&	$text )

This hook is called when a page has been processed by the parser and the resulting HTML is about to be displayed.

Since: 1.35

Parameters

OutputPage	$out	OutputPage object that corresponds to the page
string	&$text	Text that will be displayed, in HTML

Returns: bool|void This hook must not abort, it must return true or null.

Implements MediaWiki\Output\Hook\OutputPageBeforeHTMLHook.

Definition at line 385 of file ApiHookRunner.php.

◆ onOutputPageCheckLastModified()

MediaWiki\Api\ApiHookRunner::onOutputPageCheckLastModified	(	&	$modifiedTimes,
			$out )

This hook is called when checking if the page has been modified since the last visit.

Since: 1.35

Parameters

string[]	&$modifiedTimes	Array of timestamps. The following keys are set: page, user, epoch.
OutputPage	$out	since 1.28

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Output\Hook\OutputPageCheckLastModifiedHook.

Definition at line 393 of file ApiHookRunner.php.

◆ onRequestHasSameOriginSecurity()

MediaWiki\Api\ApiHookRunner::onRequestHasSameOriginSecurity ( $request )

Use this hook to determine if the request is somehow flagged to lack same-origin security.Note that if the "somehow" involves HTTP headers, you'll probably need to make sure the header is varied on.

Since: 1.35

Parameters

WebRequest $request

Returns: bool|void True or no return value to continue, or false to indicate a lack of same-origin security

Implements MediaWiki\Api\Hook\RequestHasSameOriginSecurityHook.

Definition at line 401 of file ApiHookRunner.php.

◆ onTempUserCreatedRedirect()

MediaWiki\Api\ApiHookRunner::onTempUserCreatedRedirect	(	Session	$session,
		UserIdentity	$user,
		string	$returnTo,
		string	$returnToQuery,
		string	$returnToAnchor,
		&	$redirectUrl )

This hook is called after an action causes a temporary user to be created or after the first successful edit for a temporary account.The handler may modify the redirect URL.To differentiate between invocations of this hook where a) the account was created in the current request and b) the account existed, but made a first successful edit, one can examine the registration date of the account.

Since: 1.39

Parameters

Session	$session
UserIdentity	$user
string	$returnTo	The prefixed DB key of the title to redirect to
string	$returnToQuery	An extra query part
string	$returnToAnchor	Either an empty string or a fragment beginning with "#"
string	&$redirectUrl	The URL to redirect to

Returns: bool|null

Implements MediaWiki\Hook\TempUserCreatedRedirectHook.

Definition at line 409 of file ApiHookRunner.php.

◆ onUserLoginComplete()

MediaWiki\Api\ApiHookRunner::onUserLoginComplete	(		$user,
		&	$inject_html,
			$direct )

Use this hook to show custom content after a user has logged in via the web interface.This includes both login and signup. It's also called by the action=login API (but not action=clientlogin or action=createaccount) for legacy reasons.For functionality that needs to run after any login (API or web) use UserLoggedIn.Before 1.42 this hook was also called when the user visited the login page with a returnto parameter while already logged in. Code that needs to run in that situation should use the PostLoginRedirect hook instead.

Since: 1.35

Parameters

User	$user	The user object that was created on login
string	&$inject_html	Any HTML to inject after the "logged in" message. (Setting it to a non-empty value will also prevent redirects: instead of the user being sent back to the page indicated by the returnto URL parameter, they will see a success page with $inject_html and a link to the returnto page.) On signup, the BeforeWelcomeCreation hook can further modify this value.
bool	$direct	(bool) Unused, always true. Before 1.42, it was false when the hook was called in situations other than a successful login or signup; since 1.42 those don't happen anymore.

Returns: bool|void True or no return value to continue or false to abort

See also: BeforeWelcomeCreationHook::onBeforeWelcomeCreation

Implements MediaWiki\Hook\UserLoginCompleteHook.

Definition at line 424 of file ApiHookRunner.php.

◆ onUserLogoutComplete()

MediaWiki\Api\ApiHookRunner::onUserLogoutComplete	(		$user,
		&	$inject_html,
			$oldName )

This hook is called after a user has logged out.

Since: 1.35

Parameters

User	$user	the user object after logout (won't have name, ID, etc.)
string	&$inject_html	Any HTML to inject after the "logged out" message.
string	$oldName	name of the user before logout (string)

Returns: bool|void True or no return value to continue or false to abort

Implements MediaWiki\Hook\UserLogoutCompleteHook.

Definition at line 432 of file ApiHookRunner.php.

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

includes/Api/ApiHookRunner.php