File: CategoryViewer__generateLinkHook.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 (30 lines) | stat: -rw-r--r-- 1,049 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
<?php

namespace MediaWiki\Hook;

// phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
use MediaWiki\Title\Title;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "CategoryViewer::generateLink" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface CategoryViewer__generateLinkHook {
	/**
	 * This hook is called before generating an output link allow
	 * extensions opportunity to generate a more specific or relevant link.
	 *
	 * @since 1.35
	 *
	 * @param string $type Category type, either 'page', 'file', or 'subcat'
	 * @param Title $title Categorized page
	 * @param string $html Requested HTML content of anchor
	 * @param string &$link Returned value. When set to a non-null value by a hook subscriber,
	 *   this value will be used as the anchor instead of LinkRenderer::makeLink.
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onCategoryViewer__generateLink( $type, $title, $html, &$link );
}