File: ArticleParserOptionsHook.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 (31 lines) | stat: -rw-r--r-- 794 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
28
29
30
31
<?php

namespace MediaWiki\Page\Hook;

use Article;
use MediaWiki\Parser\ParserOptions;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "ArticleParserOptions" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface ArticleParserOptionsHook {
	/**
	 * 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
	 *
	 * @param Article $article Article about to be parsed
	 * @param ParserOptions $popts Mutable parser options
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onArticleParserOptions(
		Article $article, ParserOptions $popts
	);

}