wiki.techinc.nl/includes/shell/Hook/WfShellWikiCmdHook.php
apaskulin c44488f725 docs: Hook interface doc comment review
Edited doc comments for hook interfaces to improve
consistency and add type hints.

Bug: T246855
Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
2020-04-21 09:10:08 +10:00

23 lines
654 B
PHP

<?php
namespace MediaWiki\Shell\Hook;
/**
* @stable for implementation
* @ingroup Hooks
*/
interface WfShellWikiCmdHook {
/**
* This hook is called when generating a shell-escaped command line string to
* run a MediaWiki CLI script.
*
* @since 1.35
*
* @param string &$script MediaWiki CLI script path
* @param array &$parameters Array of arguments and options to the script
* @param array &$options Associative array of options, may contain the 'php' and 'wrapper'
* keys
* @return bool|void True or no return value to continue or false to abort
*/
public function onWfShellWikiCmd( &$script, &$parameters, &$options );
}