File: APIQueryGeneratorAfterExecuteHook.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (27 lines) | stat: -rw-r--r-- 751 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?php

namespace MediaWiki\Api\Hook;

use MediaWiki\Api\ApiBase;
use MediaWiki\Api\ApiPageSet;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "APIQueryGeneratorAfterExecute" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface APIQueryGeneratorAfterExecuteHook {
	/**
	 * 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
	 *
	 * @param ApiBase $module
	 * @param ApiPageSet $resultPageSet
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onAPIQueryGeneratorAfterExecute( $module, $resultPageSet );
}