File: BeforeParserFetchTemplateRevisionRecordHook.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 (36 lines) | stat: -rw-r--r-- 1,313 bytes parent folder | download | duplicates (3)
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
28
29
30
31
32
33
34
35
36
<?php

namespace MediaWiki\Hook;

use MediaWiki\Linker\LinkTarget;
use MediaWiki\Revision\RevisionRecord;

/**
 * @stable to implement
 * @ingroup Hooks
 */
interface BeforeParserFetchTemplateRevisionRecordHook {
	/**
	 * This hook is called before a template is fetched by Parser.
	 * It allows redirection of the title and/or revision id of the
	 * template.  For example: the template could be redirected to
	 * an appropriately localized version of the template; or the
	 * template fetch could be redirected to a 'stable revision' of
	 * the template.  If the returned RevisionRecord does not exist,
	 * its title will be added to the page dependencies and then this
	 * hook will be invoked again to resolve that title.  This allows
	 * for fallback chains (of limited length).
	 *
	 * @since 1.36
	 *
	 * @param ?LinkTarget $contextTitle The top-level page title, if any
	 * @param LinkTarget $title The template link (from the literal wikitext)
	 * @param bool &$skip Skip this template and link it?
	 * @param ?RevisionRecord &$revRecord The desired revision record
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onBeforeParserFetchTemplateRevisionRecord(
		?LinkTarget $contextTitle, LinkTarget $title,
		bool &$skip, ?RevisionRecord &$revRecord
	);
}