File: BadImageHook.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 (25 lines) | stat: -rw-r--r-- 702 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
<?php

namespace MediaWiki\Hook;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "BadImage" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface BadImageHook {
	/**
	 * This hook is called when checking against the bad image list. If an image is "bad",
	 * it is not rendered inline in wiki pages or galleries in category pages.
	 *
	 * @since 1.35
	 *
	 * @param string $name Image name being checked
	 * @param bool &$bad Whether or not the image is "bad"
	 * @return bool|void True or no return value to continue, or false and change $bad
	 *   to override
	 */
	public function onBadImage( $name, &$bad );
}