MediaWiki\Shell\Hook\WfShellWikiCmdHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\Shell\Hook\WfShellWikiCmdHook:

Public Member Functions
	onWfShellWikiCmd (&$script, &$parameters, &$options)
	This hook is called when generating a shell-escaped command line string to run a MediaWiki CLI script.

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "wfShellWikiCmd" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 12 of file WfShellWikiCmdHook.php.

Member Function Documentation

onWfShellWikiCmd()

MediaWiki\Shell\Hook\WfShellWikiCmdHook::onWfShellWikiCmd	(	&	$script,
		&	$parameters,
		&	$options
	)

This hook is called when generating a shell-escaped command line string to run a MediaWiki CLI script.

Since

1.35

Parameters

string	&$script	MediaWiki CLI script path
string[]	&$parameters	Array of arguments and options to the script
array	&$options	Associative array of options, may contain the 'php' and 'wrapper' keys

Returns

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

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/shell/Hook/WfShellWikiCmdHook.php