File: OutputPageRenderCategoryLinkHook.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 (33 lines) | stat: -rw-r--r-- 930 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
32
33
<?php

namespace MediaWiki\Output\Hook;

use MediaWiki\Output\OutputPage;
use MediaWiki\Page\ProperPageIdentity;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "OutputPageRenderCategoryLink" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface OutputPageRenderCategoryLinkHook {
	/**
	 * This hook is called when a category link is rendered.
	 *
	 * @since 1.43
	 *
	 * @param OutputPage $outputPage
	 * @param ProperPageIdentity $categoryTitle Category title
	 * @param string $text HTML escaped category name
	 * @param ?string &$link HTML of rendered category link which can be replaced by a different HTML
	 * @return void This hook must not abort, it must return no value
	 */
	public function onOutputPageRenderCategoryLink(
		OutputPage $outputPage,
		ProperPageIdentity $categoryTitle,
		string $text,
		?string &$link
	): void;
}